@slhs/prettier-config/README.md

SLHS Prettier config

# @slhs/prettier-config

This is the SLHS [Prettier](https://prettier.io/) configuration.

[![npm Version](https://img.shields.io/npm/v/@slhs/prettier-config.svg?style=for-the-badge)](https://www.npmjs.com/package/@slhs/prettier-config)
[![Build Status](https://img.shields.io/badge/CI-GitHub%20Actions-success?logo=github&style=for-the-badge)](https://github.com/slhs/prettier-config/actions?query=workflow%3Aci)

### 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](https://prettier.io/docs/en/configuration.html#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`

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

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

export default config;
```