Question 1

How do I find unused ESLint rules in my config?

Accepted Answer

Run eslint-find-rules with the -u or --unused option on your config file. It will list all rules that are configured but not actively used, helping you clean up your setup. You can add it as an npm script for regular audits.

Question 2

eslint-find-rules vs eslint-find-new-rules: which should I use?

Accepted Answer

eslint-find-rules is an extended version of eslint-find-new-rules with more features like deprecated rule detection and config comparison. If you need comprehensive auditing, choose eslint-find-rules; for simpler new rule discovery, the original might suffice, but it's less maintained.

Question 3

How to integrate eslint-find-rules into a CI/CD pipeline?

Accepted Answer

Use the programmatic API to require it in Node.js scripts and run checks during build steps. For example, call getUnusedRules() and exit with an error if any are found, ensuring configs stay clean. The README shows examples of using it in npm scripts.

Question 4

Does eslint-find-rules work with ESLint flat configs?

Accepted Answer

Yes, but you need to add the --flatConfig flag when running the command, as noted in the README. Without it, the tool defaults to legacy config mode, so ensure compatibility with your ESLint version.

Question 5

Can I use eslint-find-rules with custom file extensions like .json?

Accepted Answer

Yes, use the --ext flag to specify file extensions, such as --ext .json for JSON configs. The README mentions supporting multiple extensions if needed, like --ext .js --ext .json.

Question 6

What if deprecated rules aren't detected by eslint-find-rules?

Accepted Answer

This can happen if plugins don't mark rules as deprecated in metadata. The README suggests filing pull requests with those projects, but as a workaround, manually review plugin documentation or use other audit methods.

eslint-find-rules

What is eslint-find-rules?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions