eslint-plugin-eslint-plugin

What is eslint-plugin-eslint-plugin?

eslint-plugin-eslint-plugin is an ESLint plugin designed to help developers create and maintain their own ESLint plugins. It provides rules and utilities that enforce best practices and catch common mistakes in ESLint plugin development.

What are eslint-plugin-eslint-plugin's main functionalities?

Rule to enforce meta property in rule definitions

This feature ensures that each rule in your ESLint plugin has a `meta.docs.url` property, which is useful for documentation purposes.

module.exports = {
  rules: {
    'require-meta-docs-url': require('./lib/rules/require-meta-docs-url')
  }
};

Rule to enforce correct rule tester usage

This feature checks that your rule tests are consistent and follow best practices, ensuring that your tests are reliable and maintainable.

module.exports = {
  rules: {
    'consistent-output': require('./lib/rules/consistent-output')
  }
};

Rule to enforce correct use of context.report

This feature ensures that you are using the `context.report` API correctly, avoiding deprecated methods and promoting the use of the latest API.

module.exports = {
  rules: {
    'no-deprecated-report-api': require('./lib/rules/no-deprecated-report-api')
  }
};

Other packages similar to eslint-plugin-eslint-plugin

eslint-plugin-eslint-comments

eslint-plugin-eslint-comments provides rules for best practices around ESLint directive comments (e.g., `// eslint-disable`). It helps ensure that these comments are used correctly and not overused, which is somewhat related to maintaining ESLint configurations but focuses on comments rather than plugin development.

eslint-plugin-node

eslint-plugin-node provides rules for Node.js-specific code, ensuring that your code adheres to best practices for Node.js development. While it is not focused on ESLint plugin development, it shares the goal of improving code quality through custom rules.

eslint-plugin-import

eslint-plugin-import offers rules to ensure proper import/export syntax and practices in JavaScript modules. It helps catch common issues with ES6 imports/exports, which is different from plugin development but similarly aims to improve code quality through linting.

README

eslint-plugin-eslint-plugin

An ESLint plugin for linting ESLint plugins. Rules written in CJS, ESM, and TypeScript are all supported.

• Installation
• Usage
• Rules
• Presets
  • Semantic versioning policy
  • Preset usage

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-eslint-plugin:

npm install eslint-plugin-eslint-plugin --save-dev

Usage

Here's an example ESLint configuration that:

• Sets sourceType to script for CJS plugins (most users) (use module for ESM/TypeScript)
• Enables the recommended configuration
• Enables an optional/non-recommended rule

{
    "parserOptions": {
        "sourceType": "script"
    },
    "extends": [
        "plugin:eslint-plugin/recommended"
    ],
    "rules": {
        "eslint-plugin/require-meta-docs-description": "error"
    }
}

Rules

• ✔️ if the rule belongs to the recommended configuration
• 🛠 if some problems reported by the rule are automatically fixable by the --fix command line option
• 💡 if some problems reported by the rule are manually fixable by editor suggestions

Name	✔️	🛠	💡	Description
consistent-output	✔️			enforce consistent use of output assertions in rule tests
fixer-return	✔️			require fixer functions to return a fix
meta-property-ordering		🛠		enforce the order of meta properties
no-deprecated-context-methods	✔️	🛠		disallow usage of deprecated methods on rule context objects
no-deprecated-report-api	✔️	🛠		disallow the version of context.report() with multiple arguments
no-identical-tests	✔️	🛠		disallow identical tests
no-missing-placeholders	✔️			disallow missing placeholders in rule report messages
no-only-tests	✔️		💡	disallow the test case property only
no-unused-placeholders	✔️			disallow unused placeholders in rule report messages
no-useless-token-range	✔️	🛠		disallow unnecessary calls to sourceCode.getFirstToken() and sourceCode.getLastToken()
prefer-message-ids				require using messageId instead of message to report rule violations
prefer-object-rule	✔️	🛠		disallow rule exports where the export is a function
prefer-output-null		🛠		disallow invalid RuleTester test cases where the output matches the code
prefer-placeholders				require using placeholders for dynamic report messages
prefer-replace-text				require using replaceText() instead of replaceTextRange()
report-message-format				enforce a consistent format for rule report messages
require-meta-docs-description				require rules to implement a meta.docs.description property with the correct format
require-meta-docs-url		🛠		require rules to implement a meta.docs.url property
require-meta-fixable	✔️			require rules to implement a meta.fixable property
require-meta-has-suggestions	✔️	🛠		require suggestable rules to implement a meta.hasSuggestions property
require-meta-schema	✔️		💡	require rules to implement a meta.schema property
require-meta-type	✔️			require rules to implement a meta.type property
test-case-property-ordering		🛠		require the properties of a test case to be placed in a consistent order
test-case-shorthand-strings		🛠		enforce consistent usage of shorthand strings for test cases with no options

Presets

	Name	Description
✔️	recommended	enables all recommended rules in this plugin
	rules-recommended	enables all recommended rules that are aimed at linting ESLint rule files
	tests-recommended	enables all recommended rules that are aimed at linting ESLint test files
	all	enables all rules in this plugin
	rules	enables all rules that are aimed at linting ESLint rule files
	tests	enables all rules that are aimed at linting ESLint test files

Semantic versioning policy

The list of recommended rules will only change in a major release of this plugin. However, new non-recommended rules might be added in a minor release of this plugin. Therefore, using the all, rules, and tests presets is not recommended for production use, because the addition of new rules in a minor release could break your build.

Preset usage

Presets are enabled by adding a line to the extends list in your config file. For example, to enable the recommended preset, use:

{
    "extends": [
        "plugin:eslint-plugin/recommended"
    ]
}

Or to apply linting only to the appropriate rule or test files:

{
    "overrides": [
        {
            "files": ["lib/rules/*.{js,ts}"],
            "extends": ["plugin:eslint-plugin/rules-recommended"]
        },
        {
            "files": ["tests/lib/rules/*.{js,ts}"],
            "extends": ["plugin:eslint-plugin/tests-recommended"]
        },
    ]
}

Changelog

4.2.0 (2022-05-16)

Features

• Detect nested test cases (#249) (b33aa00)