Skip to content
This repository has been archived by the owner on Jan 28, 2024. It is now read-only.

ESLint plugin to completely ban disabling specific rules. πŸ™…

License

Notifications You must be signed in to change notification settings

JoshuaKGoldberg/eslint-plugin-never-disable

Repository files navigation

eslint-plugin-never-disable

ESLint plugin to completely ban disabling specific rules. πŸ™…

All Contributors: 2 πŸ‘ͺ Codecov Test Coverage Contributor Covenant License: MIT Style: Prettier TypeScript: Strict npm package version

Archived

Use eslint-comments/no-restricted-disable instead.

Usage

Add the following options to your ESLint configuration file:

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:

// 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 Completely bans disabling specific rules.

Contributors

Josh Goldberg ✨
Josh Goldberg ✨

πŸ’» πŸ–‹ πŸ“– πŸ€” πŸš‡ 🚧 πŸ“† πŸ”§ πŸ›
StyleShit
StyleShit

πŸ› πŸ’» πŸ“– πŸ€”

πŸ’™ This package was templated with create-typescript-app.