Registry / devops / prettier-plugin-ignored

prettier-plugin-ignored

library1.0.0jsnpmunverified

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.

devops

npm install prettier-plugin-ignored

github ↗package ↗

INSTALL

IMPORT

SIG · PRETTIER-PLUGIN-IG

prettier-plugin-ignored

devopsjavascriptv1.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default (plugin registration)

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

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

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

parserName

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

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

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

plugin options (if any)

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

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

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

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 .

Debug

Known issues

breakingPlugin requires Prettier 3.x; does not work with Prettier 2.x.

fix

Upgrade Prettier to version 3 or later.

affects: >=1.0.0

gotchaThe 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.

affects: *

deprecatedNo deprecated warnings as of v1.0.0.

fix

N/A

affects: none

Errors

Common errors & fixes

Cannot find module 'prettier-plugin-ignored'

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: Cannot resolve parser 'ignored'

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

fix

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

[error] Invalid parser name: 'ignored'

Using a typo or wrong parser string.

fix

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

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

prettierrequiredpeer dependency, plugin requires Prettier 3.x to run

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/tobysmith568/prettier-plugin-ignored ↗

packagehttps://www.npmjs.com/package/prettier-plugin-ignored ↗