README.md

prettier-config

The shareable configuration for Prettier used in all Devoxa projects

Installation • Usage • Extending • Contributors • License

Installation

yarn add --dev @devoxa/prettier-config prettier typescript

Usage

To enable the rules, add a prettier property in your package.json. See the Prettier configuration docs for more details.

"prettier": "@devoxa/prettier-config"

It is also recommended to add the following scripts to your package.json for easy usage.

"format": "prettier --ignore-path='.gitignore' --list-different --write .",
"format:check": "prettier --ignore-path='.gitignore' --check .",

Additionally, it is recommended to install the VS Code Extension to get in-editor formatting support.

Extending

This configuration is not intended to be changed, but if you have a setup where modification is required, it is possible. To extend a configuration you will need to use a prettier.config.js file that exports an object:

module.exports = {
  ...require('@devoxa/prettier-config'),
  semi: true,
}

Contributors

Thanks goes to these wonderful people (emoji key):

David Reeß 💻 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT