https://github.com/joshuakgoldberg/eslint-plugin-never-disable

ESLint plugin to completely ban disabling specific rules. 🙅
https://github.com/joshuakgoldberg/eslint-plugin-never-disable

eslint eslint-plugin

Last synced: 3 months ago
JSON representation

ESLint plugin to completely ban disabling specific rules. 🙅

• Host: GitHub
• URL: https://github.com/joshuakgoldberg/eslint-plugin-never-disable
• Owner: JoshuaKGoldberg
• License: mit
• Archived: true
• Created: 2023-12-07T21:02:47.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-28T18:06:36.000Z (11 months ago)
• Last Synced: 2024-09-28T01:04:38.984Z (3 months ago)
• Topics: eslint, eslint-plugin
• Language: TypeScript
• Homepage:
• Size: 491 KB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
eslint-plugin-never-disable


ESLint plugin to completely ban disabling specific rules. 🙅




	

	

	

	

	

	

	

	

	

	



## Archived

**Use [`eslint-comments/no-restricted-disable`](https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/no-restricted-disable.html) instead.**

## Usage

Add the following options to your [ESLint configuration file](https://eslint.org/docs/latest/user-guide/configuring/configuration-files):

```js

module.exports = {

	// ...

	plugins: ["never-disable"],

	rules: {

		"never-disable/rules": [

			"error",

			{

				rules: [

					{

						message: "Explanation for why this is so.",

						rule: "rule-to-never-disable",

					},

				],

			},

		],

	},

	// ...

};

```

Then developers will receive the following error upon trying to disable a never-to-be-disabled rule:

```plaintext

// eslint-disable-next-line rule-to-never-disable

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Rule 'rule-to-never-disable' should not be disabled. Explanation for why this is so.

```

| Name                         | Description                               |

| :--------------------------- | :---------------------------------------- |

| [rules](docs/rules/rules.md) | Completely bans disabling specific rules. |

## Contributors

  

    

      
Josh Goldberg ✨
💻 🖋 📖 🤔 🚇 🚧 📆 🔧 🐛

      
StyleShit
🐛 💻 📖 🤔

    

  

> 💙 This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app).