@slhs/prettier-config

This is the SLHS Prettier configuration.

Install

npm install --save-dev @slhs/prettier-config

Be sure to install the appropriately versioned prettier peer dependency as well.

Usage

Follow the Prettier documentation on sharing configurations.

Examples

package.json

{
  "prettier": "@slhs/prettier-config",
  "scripts": {
    ...
    "format": "prettier --cache --write .",
    "format:check": "prettier --cache --check .",
    ...
  }
}

.prettierignore

# .gitignore and...

.changeset
.vscode
package.json
package-lock.json

Customization

If you need to customize the configuration, you can use a dedicated Prettier config file instead of the one-liner in package.json:

prettier.config.js

import slhsConfig from '@slhs/prettier-config';

/** @type {import("prettier").Options} */
export const config = {
  ...slhsConfig,
  // overrides here
};

export default config;