https://github.com/eslint-community/eslint-plugin-eslint-comments

Additional ESLint rules for directive comments of ESLint.
https://github.com/eslint-community/eslint-plugin-eslint-comments

eslint eslint-plugin

Last synced: 2 months ago
JSON representation

Additional ESLint rules for directive comments of ESLint.

• Host: GitHub
• URL: https://github.com/eslint-community/eslint-plugin-eslint-comments
• Owner: eslint-community
• License: mit
• Fork: true (mysticatea/eslint-plugin-eslint-comments)
• Created: 2023-01-14T00:21:19.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-15T09:25:01.000Z (5 months ago)
• Last Synced: 2024-09-15T11:29:04.847Z (4 months ago)
• Topics: eslint, eslint-plugin
• Language: JavaScript
• Homepage: https://eslint-community.github.io/eslint-plugin-eslint-comments
• Size: 287 KB
• Stars: 50
• Watchers: 5
• Forks: 7
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-eslint - @eslint-community/eslint-plugin-eslint-comments - Best practices about ESLint directive comments (`/*eslint-disable*/`, etc.). Properly maintained fork of no longer maintained `eslint-plugin-eslint-comments`. (Plugins / Practices and Specific ES Features)

README

        
# @eslint-community/eslint-plugin-eslint-comments

[![npm version](https://img.shields.io/npm/v/@eslint-community/eslint-plugin-eslint-comments.svg)](https://www.npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments)

[![Downloads/month](https://img.shields.io/npm/dm/@eslint-community/eslint-plugin-eslint-comments.svg)](http://www.npmtrends.com/@eslint-community/eslint-plugin-eslint-comments)

[![Build Status](https://github.com/eslint-community/eslint-plugin-eslint-comments/workflows/CI/badge.svg)](https://github.com/eslint-community/eslint-plugin-eslint-comments/actions)

[![codecov](https://codecov.io/gh/eslint-community/eslint-plugin-eslint-comments/branch/main/graph/badge.svg)](https://codecov.io/gh/eslint-community/eslint-plugin-eslint-comments)

Additional ESLint rules for ESLint directive comments (e.g. `//eslint-disable-line`).

## 📖 Usage

- [Documentation](https://eslint-community.github.io/eslint-plugin-eslint-comments)

## 🚥 Semantic Versioning Policy

`@eslint-community/eslint-plugin-eslint-comments` follows [semantic versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).

## 📰 Changelog

- [GitHub Releases](https://github.com/eslint-community/eslint-plugin-eslint-comments/releases)

## 🍻 Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

### Development Tools

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