eslint-plugin-eslint-comments
Advanced tools
Package description
The eslint-plugin-eslint-comments npm package provides a set of linting rules for ESLint directive comments (e.g., /* eslint-disable */, /* eslint-enable */, etc.). It helps in managing and enforcing best practices for the use of ESLint directive comments within your codebase. This includes rules for preventing unused or unnecessary disabling of rules, ensuring proper enable/disable pairs, and more.
Disallow Unused ESLint Disable Comments
This rule helps in identifying ESLint disable comments that are unnecessary because the rules they are disabling are not actually reported. It helps in keeping the codebase clean and avoiding confusion about why a rule was disabled.
"eslint-comments/no-unused-disable": "error"Require Description in ESLint Directive Comments
Enforces that all ESLint directive comments include a description, making it clearer why a rule was disabled or enabled at a specific point in the code. This is useful for maintaining code quality and understanding the context behind disabling a rule.
"eslint-comments/require-description": ["error", { "ignore": [] }]Disallow Duplicate Disable Comments
Prevents multiple ESLint disable comments for the same rule on consecutive lines. This rule ensures that disable comments are used efficiently and are not repeated unnecessarily.
"eslint-comments/no-duplicate-disable": "error"This package provides linting rules related to ES6+ import/export syntax, ensuring proper paths, naming, and more. While it focuses on module syntax, eslint-plugin-eslint-comments focuses on managing ESLint directive comments. Both contribute to maintaining code quality but in different areas.
Offers a set of rules for working with promises, ensuring best practices and avoiding common pitfalls in asynchronous code. Unlike eslint-plugin-eslint-comments, which is focused on ESLint directives, eslint-plugin-promise focuses on the specific area of promise usage.
This package includes ESLint rules for accessibility in JSX elements, helping developers write accessible code. It's different from eslint-plugin-eslint-comments as it focuses on accessibility concerns rather than the management of ESLint directive comments.
Readme
Additional ESLint rules for ESLint directive comments (e.g. //eslint-disable-line).
eslint-plugin-eslint-comments follows semantic versioning and ESLint's Semantic Versioning Policy.
Welcome contributing!
Please use GitHub's Issues/PRs.
npm test runs tests and measures coverage.npm run build updates README.md, index.js, and the header of all rule's documents.npm run clean removes the coverage of the last npm test command.npm run coverage shows the coverage of the last npm test command.npm run lint runs ESLint for this codebase.npm run watch runs tests and measures coverage when source code are changed.FAQs
Additional ESLint rules for ESLint directive comments.
The npm package eslint-plugin-eslint-comments receives a total of 2,175,720 weekly downloads. As such, eslint-plugin-eslint-comments popularity was classified as popular.
We found that eslint-plugin-eslint-comments demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.