ignore-lint-errors

Codemod to ignore lint errors per line

Why?

In large production projects, ignoring lint errors for existing code is the most pragmatic, quickest approach to complete these tasks:

• Introduce a new lint rule.
• Update a linter to the next minor or major version.
• Migrate code to a different format, e.g. convert *.{gjs,js} (JavaScript) to *.{gts,ts} (TypeScript).

For the sake of reducing noise, some prefer disabling linting for the entire file. They do so by adding a global directive (e.g. eslint-disable) or creating a special file to "suppress" files with many errors.

Instead, ignore-lint-errors takes the honest approach: It adds a local directive (e.g. eslint-disable-next-line) for every line that has an error. This way, we can easily see and show others (including non-engineers and AIs),

• How bad our code is to increase the urgency to fix issues. The number of local ignores (1 per line) will always estimate the actual number of errors better than the number of global ignores (1 per file).
• Which parts of our code are good and should be replicated, and which parts are bad and to be avoided. When there is a global ignore, a linter won't check the file for the given rule(s).

Usage

Step 1. Run codemod.

cd <path/to/your/project>
pnpx ignore-lint-errors <arguments>

Step 2. Fix formatting.

# Run prettier
pnpm prettier . --write

Arguments

You must pass --linter to indicate which linter to run.

# Run eslint
pnpx ignore-lint-errors --linter eslint

# Run stylelint
pnpx ignore-lint-errors --linter stylelint

# Run glint or typescript
pnpx ignore-lint-errors --linter typescript

Optional: Specify the project root

Pass --root to run the codemod somewhere else (i.e. not in the current directory).

pnpx ignore-lint-errors --root <path/to/your/project>

Optional: Specify files to lint

Pass --src to lint specific files.

# eslint supports files
pnpx ignore-lint-errors --linter eslint --src app/components/example-1.gts app/templates/example-2.gts

# eslint supports directories
pnpx ignore-lint-errors --linter eslint --src app tests

# eslint supports globs
pnpx ignore-lint-errors --linter eslint --src app/{components,templates}/**/*.gts

# stylelint supports files
pnpx ignore-lint-errors --linter stylelint --src app/components/example-1.module.css app/templates/example-2.module.css

# stylelint supports globs
pnpx ignore-lint-errors --linter stylelint --src app/components/**/*.css

Limitations

The codemod is designed to cover typical cases. It is not designed to cover one-off cases.

To better meet your needs, consider cloning the repo and running the codemod locally.

cd <path/to/cloned/repo>

# Compile TypeScript
pnpm build

# Run codemod
./dist/bin/ignore-lint-errors.js --root <path/to/your/project>

Compatibility

• Node.js v22 or above
• Tested against eslint@v9, glint@v2, stylelint@v17, typescript@v5

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.