prettier-config

Check Digit Prettier configuration

Usage

Install

$ npm add -D -E @checkdigit/prettier-config

Important note from Prettier installation documentation:

Install an exact version of Prettier locally in your project. This makes sure that everyone in the project gets the exact same version of Prettier. Even a patch release of Prettier can result in slightly different formatting, so you wouldn’t want different team members using different versions and formatting each other’s changes back and forth.

To make this easier, just install @checkdigit/prettier-config as above, it will be locked to a specific version of prettier which will automatically be installed via its peerDependencies. Do not specifically install prettier itself as a dependency.

Edit package.json

{
  // ...
  "prettier": "@checkdigit/prettier-config"
  // ...
  scripts: {
    // ...
    "prettier": "prettier --ignore-path .gitignore --list-different .",
    "prettier:fix": "prettier --ignore-path .gitignore --write .",
    // ...
    "test": "... && npm run prettier"
    // ...
  }
}

In addition to running tests and linting, prettier should also be used by npm test to validate formatting.

If there are issues, npm run prettier:fix will re-format the entire project to the required style.

Note: using .gitignore as the ignore path will ensure that Prettier will ignore files that are ignored by Git. In most cases this is the desired behavior, otherwise you can use a custom .pretterignore file.

Add .prettierignore file (optional)

If you have generated TypeScript files you can have Prettier ignore them by creating a .prettierignore file like so:

src/api/*/swagger.ts

WebStorm

WebStorm supports Prettier, turn on within the preferences at: Languages and Frameworks | JavaScript | Prettier.

You can use ⌥⇧⌘P to format a block with Prettier. WebStorm should also ask if you want to apply Prettier code style rules across the project. (say yes)

License

MIT