Prettier Configuration
Prettier is an opinionated code formatter and removes all original styling and ensures that all outputted code conforms to a consistent code style across your entire codebase. - https://prettier.io/docs/en/index.html
This is the shared prettier configuration used at Boehringer Ingelheim for code formatting.
Usage
Install the package
npm install --save-dev @boehringer-ingelheim/prettier-config
Add the configuration
Create or update the .prettierrc.js
file in your projects root directory accordingly.
module.exports = require("@boehringer-ingelheim/prettier-config");
Extend configuration
This is not recommended as the goal is to have similar settings in all projects, but if for some reason you need to add or change the configuration, it is possible in the following way.
module.exports = {
...require("@boehringer-ingelheim/prettier-config"),
printWidth: 140,
};
Run
npx prettier --write .
Options
Opinionated Options that differ from the standard Prettier options.
Print Width
Specify the line length that the printer will wrap on.
printWidth: 120;
Local Development
Install Dependencies
npm install
Test
npm test
Repair
This command may be useful when obscure errors or issues are encountered. It removes and recreates dependencies of your project.
npm run repair
Release
Fully automated version management and package publishing via semantic-release. It bumps the version according to conventional commits, publishes the package to npm and release a new version to GitHub.
Automatic Release (GitHub Action) [Recommended]
Make sure that the secrets GITHUB_TOKEN
and NPM_TOKEN
are available in GitHub repository.
npm run release:ci
Manual Release
Make sure that the environment variables GITHUB_TOKEN
and NPM_TOKEN
are set or declared in .env
and a productive build was previously created via npm run build
.
npm run release
Show your support
Give a
License
Copyright © 2022 Boehringer Ingelheim.
This project is MIT licensed.