Shared Prettier configuration accross Ackee's projects.
-
Install the config
prettier-config-ackee
:$ yarn add -D prettier-config-ackee
-
Create a new file called
prettier.config.mjs
in the root of your project:const { config } = require('@ackee/prettier-config') module.exports = config
-
Add prettier plugin to your editor
If you're using ESLint, you want to turn off all rules that are unnecessary or might conflict with Prettier.
-
Install eslint-config-prettier:
$ yarn add -D eslint-config-prettier
-
Then, add eslint-config-prettier to the "extends" array in your .eslintrc.* file (or in
eslintConfig
object placed inpackage.json
). Make sure to putprettier
as the last one, so it can override other configs.{ "extends": ["ackee", "prettier"] }
After adding Prettier to your project, you probably want to format all current code. Why? Because if you don't do that, then when you create your next MR, most of the changes is going to be caused by the new code formatting.
- Install
prettier
$ yarn add -D prettier
- Add script to the
package.json
of your project:This script is going to recursively format code (code = files that match the{ "scripts": { "prettier": "prettier --config ./prettier.config.js --write 'src/**/*.{ts,tsx,cjs,mjs,js,md,scss,css,jsx}'" } }
*.{js,md,scss,css,jsx}
glob pattern) in yoursrc/
directory with Prettier rules fromprettier.config.js
file.
To discuss
You can find current options to discuss at github issues page.