prettier-plugin-ignored

1.0.0 verified Sat Apr 25 auth: no javascript

A Prettier plugin that introduces an 'ignored' language parser, allowing files to be ignored without a .prettierignore file. Current stable version: 1.0.0. Released in April 2025, with infrequent updates. Key differentiator: enables sharing ignored file patterns across repositories via Prettier config overrides, unlike .prettierignore which cannot be shared. Requires Prettier 3.x. Written in TypeScript, ships types.

Common errors

error Cannot find module 'prettier-plugin-ignored' ↓

cause Plugin not installed or devDependencies not installed.

fix

Run npm install --save-dev prettier-plugin-ignored or ensure node_modules is up-to-date.

error Error: Cannot resolve parser 'ignored' ↓

cause Plugin not registered in Prettier config's 'plugins' array.

fix

Add "plugins": ["prettier-plugin-ignored"] to your Prettier config.

error [error] Invalid parser name: 'ignored' ↓

cause Using a typo or wrong parser string.

fix

Ensure the parser in overrides.options is exactly "ignored" (lowercase, no spaces).

Warnings

breaking Plugin requires Prettier 3.x; does not work with Prettier 2.x. ↓

fix Upgrade Prettier to version 3 or later.

gotcha The plugin overrides Prettier's behavior: files matched by overrides will be output exactly as input, even if they contain formatting issues. This may mask unintentional formatting problems. ↓

fix Ensure overrides only target files you intend to ignore; review regularly.

deprecated No deprecated warnings as of v1.0.0. ↓

fix N/A

Install

npm install prettier-plugin-ignored

yarn add prettier-plugin-ignored

pnpm add prettier-plugin-ignored

Imports

default (plugin registration)

wrong

// Wrong: importing as a JavaScript module when not needed
import plugin from 'prettier-plugin-ignored'

correct

// In .prettierrc: "plugins": ["prettier-plugin-ignored"]

This is a Prettier plugin, not a regular import. Register it in your Prettier config file.

parserName

wrong

// Wrong: using a different name
const parserName = 'ignore';

correct

const parserName = 'ignored'; // Use this in config overrides

The parser string must be exactly 'ignored' to match the plugin's registered parser.

plugin options (if any)

wrong

// Wrong: trying to require the plugin in code
const prettierPluginIgnored = require('prettier-plugin-ignored');

correct

// No options to import, plugin works automatically when added to plugins list

The plugin is used declaratively via Prettier config; no programmatic API is exported.

Quickstart

Install plugin, add to Prettier config with parser overrides to ignore specific files without .prettierignore.

// 1. Install the plugin
npm install --save-dev prettier@3 prettier-plugin-ignored

// 2. Create .prettierrc.json:
{
  "plugins": ["prettier-plugin-ignored"],
  "overrides": [
    {
      "files": ["pnpm-lock.yaml", "public/**.json"],
      "options": {
        "parser": "ignored"
      }
    }
  ]
}

// 3. Run Prettier:
npx prettier --write .