Prettier Config Documentation

Documentation for the @strv/prettier-config module.

Usage

# Yarn:
yarn add --dev @strv/prettier-config

# npm:
npm install --save-dev @strv/prettier-config

And reference it in your .prettierrc.js file:

module.exports = require('@strv/prettier-config')

Or you can of course choose your preffered way of using configs:

{
  // ...
  "prettier": "@strv/prettier-config"
}

{
  "extends": ["@strv/prettier-config"]
}

Note: If you are using prettier < v1.17 check this note.

Extending

To extend the current options you will need to create a .prettierrc.js and add the following:

module.exports = {
  ...require('@strv/prettier-config'),

  // Add custom options bellow:
  useTabs: true,
}

Notes

Prettier version

Versions of prettier prior to v1.17 did not feature the possibility to use a shared config via package.json. The way to do it is similar to when extending, except that you can just export the config directly:

// .prettierrc.js

module.exports = require('@strv/prettier-config')

More

• Prettier Documentation