5.4.1 • Published 9 days ago

eslint-plugin-eslint-plugin v5.4.1

Weekly downloads
201,566
License
MIT
Repository
github
Last release
9 days ago

eslint-plugin-eslint-plugin CI NPM version Conventional Commits

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

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

.eslintrc.json

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

eslint.config.js (requires eslint>=v8.23.0)

const eslintPluginRecommended = require('eslint-plugin-eslint-plugin/configs/recommended');
module.exports = [
  eslintPluginRecommended,
  {
    languageOptions: { sourceType: 'commonjs' },
    rules: {
      'eslint-plugin/require-meta-docs-description': 'error',
    },
  },
];

Rules

💼 Configurations enabled in.\ ✅ Set in the recommended configuration.\ 🔧 Automatically fixable by the --fix CLI option.\ 💡 Manually fixable by editor suggestions.\ 💭 Requires type information.

Rules

Name                         Description💼🔧💡💭
fixer-returnrequire fixer functions to return a fix
meta-property-orderingenforce the order of meta properties🔧
no-deprecated-context-methodsdisallow usage of deprecated methods on rule context objects🔧
no-deprecated-report-apidisallow the version of context.report() with multiple arguments🔧
no-missing-message-idsdisallow messageIds that are missing from meta.messages
no-missing-placeholdersdisallow missing placeholders in rule report messages
no-property-in-nodedisallow using in to narrow node types instead of looking at properties💭
no-unused-message-idsdisallow unused messageIds in meta.messages
no-unused-placeholdersdisallow unused placeholders in rule report messages
no-useless-token-rangedisallow unnecessary calls to sourceCode.getFirstToken() and sourceCode.getLastToken()🔧
prefer-message-idsrequire using messageId instead of message or desc to report rule violations
prefer-object-ruledisallow function-style rules🔧
prefer-placeholdersrequire using placeholders for dynamic report messages
prefer-replace-textrequire using replaceText() instead of replaceTextRange()
report-message-formatenforce a consistent format for rule report messages
require-meta-docs-descriptionrequire rules to implement a meta.docs.description property with the correct format
require-meta-docs-urlrequire rules to implement a meta.docs.url property🔧
require-meta-fixablerequire rules to implement a meta.fixable property
require-meta-has-suggestionsrequire suggestable rules to implement a meta.hasSuggestions property🔧
require-meta-schemarequire rules to implement a meta.schema property💡
require-meta-typerequire rules to implement a meta.type property

Tests

Name                       Description💼🔧💡💭
consistent-outputenforce consistent use of output assertions in rule tests
no-identical-testsdisallow identical tests🔧
no-only-testsdisallow the test case property only💡
prefer-output-nulldisallow invalid RuleTester test cases where the output matches the code🔧
test-case-property-orderingrequire the properties of a test case to be placed in a consistent order🔧
test-case-shorthand-stringsenforce consistent usage of shorthand strings for test cases with no options🔧

Presets

NameDescription
recommendedenables all recommended rules in this plugin
rules-recommendedenables all recommended rules that are aimed at linting ESLint rule files
tests-recommendedenables all recommended rules that are aimed at linting ESLint test files
allenables all rules in this plugin, excluding those requiring type information
all-type-checkedenables all rules in this plugin, including those requiring type information
rulesenables all rules that are aimed at linting ESLint rule files
testsenables 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"]
    }
  ]
}
5.4.1

9 days ago

5.4.0

1 month ago

5.3.0

2 months ago

5.2.1

4 months ago

5.2.0

4 months ago

5.1.1

8 months ago

5.1.0

11 months ago

5.0.8

1 year ago

5.0.7

1 year ago

5.0.6

2 years ago

5.0.5

2 years ago

4.4.1

2 years ago

4.4.0

2 years ago

4.2.0

2 years ago

5.0.4

2 years ago

5.0.3

2 years ago

5.0.2

2 years ago

5.0.1

2 years ago

5.0.0

2 years ago

4.3.0

2 years ago

4.0.3

2 years ago

4.1.0

2 years ago

4.0.2

2 years ago

4.0.0-3

2 years ago

4.0.0-2

2 years ago

4.0.1

2 years ago

4.0.0

2 years ago

4.0.0-0

2 years ago

4.0.0-1

2 years ago

3.6.1

3 years ago

3.6.0

3 years ago

3.5.3

3 years ago

3.5.2

3 years ago

3.5.1

3 years ago

3.5.0

3 years ago

3.4.0

3 years ago

3.3.0

3 years ago

3.2.0

3 years ago

3.1.0

3 years ago

3.0.3

3 years ago

3.0.2

3 years ago

3.0.1

3 years ago

3.0.0

3 years ago

2.3.0

4 years ago

2.2.2

4 years ago

2.2.1

4 years ago

2.2.0

4 years ago

2.1.0

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.4.1

5 years ago

1.4.0

6 years ago

1.3.0

6 years ago

1.2.0

7 years ago

1.1.0

7 years ago

1.0.0

7 years ago

0.8.0

7 years ago

0.7.4

7 years ago

0.7.3

7 years ago

0.7.2

7 years ago

0.7.1

7 years ago

0.7.0

7 years ago

0.6.0

7 years ago

0.5.0

7 years ago

0.4.0

7 years ago

0.3.0

7 years ago

0.2.1

7 years ago

0.2.0

7 years ago

0.1.0

7 years ago