prettier-ignore

0.5.0 verified Sat Apr 25 auth: no javascript

A utility package that provides commonly used ignore patterns for Prettier to skip files and folders like pnpm-lock.yaml, dist, coverage, etc. Version 0.5.0 requires Node.js >=20.19.0 and is actively maintained. It packages community-agreed ignore rules that Prettier does not ignore by default, saving users from manually listing them. It is distributed via npm and integrates with Prettier's --ignore-path option.

Common errors

error Error: Cannot find module 'prettier-ignore' ↓

cause Using require('prettier-ignore') as if it exports a module.

fix

Use require.resolve('prettier-ignore') to get the path or use the file directly.

error Unrecognized option '--ignore path' ↓

cause Typo in option name: '--ignore path' instead of '--ignore-path'.

fix

Use --ignore-path (with hyphen).

Warnings

breaking Node.js >=20.19.0 is required since version 0.5.0. ↓

fix Upgrade Node.js to >=20.19.0 or stick to version <0.5.0.

gotcha The package does not expose any JavaScript API; it only provides a file. ↓

fix Do not try to import or require the module programmatically; use the file path directly.

gotcha The ignore file is located at node_modules/prettier-ignore/prettierignore, not at the package root. ↓

fix Use the full path: ./node_modules/prettier-ignore/prettierignore.

Install

npm install prettier-ignore

yarn add prettier-ignore

pnpm add prettier-ignore

Imports

prettierignore

wrong

import { prettierignore } from 'prettier-ignore';

correct

const path = require('path'); const ignorePath = path.join(require.resolve('prettier-ignore'), '../prettierignore');

The package provides a file, not a JS export. Use the file path directly.

prettier-ignore/prettierignore

wrong

npx prettier --ignore path ./node_modules/prettier-ignore/prettierignore

correct

npx prettier --ignore-path ./node_modules/prettier-ignore/prettierignore

The option is --ignore-path (with hyphen, not space).

require('prettier-ignore')
wrong
```
const ignore = require('prettier-ignore');
```
correct
```
const ignorePath = require.resolve('prettier-ignore')
```
require() returns the module's main entry (if any), not the ignore file. Use require.resolve to get the directory path.

Quickstart

Shows how to install and use prettier-ignore with Prettier's --ignore-path option.

// Install: npm i prettier-ignore -D
// Then run Prettier with the ignore file:
npx prettier --ignore-path ./node_modules/prettier-ignore/prettierignore --check .