Archilogic's shared Prettier configuration
To use the shared Prettier config in your project, add this package as a dev dependency (along with Prettier itself):
npm i -D prettier @archilogic/prettier
Then, add a prettier
option to your package.json
:
{
"name": "ui-components",
"version": "9000.0.1",
"scripts": {...},
"prettier": "@archilogic/prettier"
}
or create a .prettierrc.json
file with the following line:
"@archilogic/prettier"
To format all your files, run npx prettier --write .
.
Or add a script to package.json
"scripts": {
"format": "prettier --write ."
}
To enforce Prettier formatting in a project, you can configure it to run as a pre-commit hook. See pre-commits docs (Option 1 recommended).
It is recommended that you set up your editor to automatically format the code as you go. See editor integration docs.
Recommended Prettier settings in this config are based on StandardJS:
- 2 spaces for indentation
- No semi-colons (Prettier takes care of the edgecases)
- Single quotes for strings
If you need to extend the configuration or overwrite some of its settings, import the file in a .prettierrc.js
file and export the modifications, e.g:
module.exports = {
...require("@company/prettier-config"),
semi: false,
};