@andrewmcodes/prettier-config

This is a shareable Prettier configuration, which includes a set of preferred styling rules that can be easily extended.

Installation

# npm
npm install --save-dev @andrewmcodes/prettier-config
# yarn
yarn add -D @andrewmcodes/prettier-config

Usage

You can use this a few different ways, but the recommended approach is to add it to your package.json:

"prettier": "@andrewmcodes/prettier-config"

If you don’t want to use package.json, you can use any of the supported extensions to export a string, e.g. .prettierrc.json:

"@andrewmcodes/prettier-config"

If you need to extend the configuration, you can use the .js extension and export an object:

module.exports = {
  ...require("@andrewmcodes/prettier-config"),
  semi: false,
};

Contributing

I'd love your help refining this package. Please don't hesitate to send a pull request.

Code Style

Run yarn format before committing to ensure your changes comply with our coding style.

Commit Messages

This project uses Conventional Commits. Please make sure your commit messages follow this format.

License

The gem is available as open source under the terms of the MIT License.