# @checkdigit/prettier-config

> Check Digit code formatting configuration

Latest version **8.1.1** (published 2026-07-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @checkdigit/prettier-config
pnpm add @checkdigit/prettier-config
yarn add @checkdigit/prettier-config
bun add @checkdigit/prettier-config
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 8.1.1 |
| Published | 2026-07-24 |
| First published | 2019-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Check Digit, LLC |
| Maintainers | npm-checkdigit, carlansley, bobwieler, ramaghanta, aarontay, yeshima, adcreare, checkdigit-deploy, lukebearden, greg-w101, le-cong |

## Links

- npm: https://www.npmjs.com/package/@checkdigit/prettier-config
- Repository: https://github.com/checkdigit/prettier-config
- Homepage: https://github.com/checkdigit/prettier-config#readme
- Issues: https://github.com/checkdigit/prettier-config/issues
- npm.io page: https://npm.io/package/@checkdigit/prettier-config

## Recent versions

- 8.1.1 (latest) — 2026-07-24
- 8.2.0-PR.68-b581 (beta) — 2026-09-14
- 8.1.1-PR.66-e69d — 2026-07-23
- 8.1.1-PR.66-dfb1 — 2026-07-13
- 8.1.1-PR.66-151f — 2026-07-13
- 8.1.1-PR.66-8dda — 2026-07-13
- 8.1.0 — 2026-07-02
- 8.1.0-PR.64-b909 — 2026-06-30
- 8.1.0-PR.64-fe1e — 2026-06-30
- 8.1.0-PR.64-4014 — 2026-06-30
- 8.1.0-PR.64-e23b — 2026-06-29
- 8.1.0-PR.64-f1ea — 2026-06-29
- 8.1.0-PR.64-cceb — 2026-06-29
- 8.0.0 — 2026-01-15
- 8.0.0-PR.62-1fa6 — 2026-01-15
- … 59 more at https://npm.io/package/@checkdigit/prettier-config/versions

## README

[![MIT License](https://img.shields.io/github/license/checkdigit/prettier-config)](https://github.com/checkdigit/prettier-config/blob/master/LICENSE.txt)

# prettier-config

Check Digit [Prettier](https://prettier.io) configuration

Copyright © 2021–2026 [Check Digit, LLC](https://checkdigit.com)

## Usage

### Install

```bash
$ npm add -D @checkdigit/prettier-config
```

Important note from [Prettier installation documentation](https://prettier.io/docs/en/install.html):

> Install an exact version of Prettier locally in your project. This makes sure that everyone in the project
> gets the exact same version of Prettier. Even a patch release of Prettier can result in slightly different
> formatting, so you wouldn’t want different team members using different versions and formatting each other’s
> changes back and forth.

To make this easier, just install `@checkdigit/prettier-config` as above, it will be locked to a specific version
of `prettier` which will automatically be installed via its `peerDependencies`.
Do not specifically install `prettier` itself as a dependency.

### Edit `package.json`

```jsonc
{
  // ...
  "prettier": "@checkdigit/prettier-config"
  // ...
  scripts: {
    // ...
    "prettier": "prettier . --check",
    "prettier:fix": "prettier . --write",
    // ...
    "test": "... && npm run prettier"
    // ...
  }
}
```

In addition to running tests and linting, prettier should also be used by `npm test` to validate formatting.

If there are issues, `npm run prettier:fix` will re-format the entire project to the required style.

Note: Prettier 3.0 and newer ignore files listed in `.gitignore` by default. If you need additional Prettier-specific
exclusions, add them to a `.prettierignore` file.

### Add `.prettierignore` file (optional)

If you have generated TypeScript files you can have Prettier ignore them by creating a `.prettierignore` file like so:

```
src/api/*/swagger.ts
```

### WebStorm

WebStorm supports Prettier, turn on within the preferences at: Languages and Frameworks | JavaScript | Prettier.

You can use ⌥⇧⌘P to format a block with Prettier. WebStorm should also ask if you want to apply Prettier code style rules across the project. (say yes)

## License

MIT

---
_Source: https://npm.io/package/@checkdigit/prettier-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._