Introduction

eslint-plugin-eslint-rule-tester is an experimental ESLint plugin that auto-fixes test cases defined in RuleTester.

:name_badge: What is this plugin?

An experimental ESLint plugin that auto-fixes test cases defined in RuleTester.
This plugin checks the test cases of the rules of the ESLint plugin, reports any differences between the expected value and the actual rule result, and auto-fixes them.
Note that this plugin's rules execute the ESLint rules you are creating during the linting check, so if the implementation of the ESLint rules you are creating has side effects, it may break your development environment.

:cd: Installation

npm install --save-dev eslint eslint-plugin-eslint-rule-tester

Requirements

• ESLint v8.0.0 and above
• Node.js v18.x and above

:book: Usage

Configuration

Use eslint.config.js file to configure rules. See also: https://eslint.org/docs/user-guide/configuring.

Example eslint.config.js:

import eslintRuleTester from 'eslint-plugin-eslint-rule-tester';
export default [
  {
    // It is recommended to apply it only to rule test cases.
    files: ['test/rules/*'],
    plugins: { 'eslint-rule-tester': eslintRuleTester },
    rules: {
      'eslint-rule-tester/valid-testcase': 'error'
    }
  }
];

We also recommend that you configure this rule configuration so that it is applied only from the editor extension.

:computer: Editor Integrations

Visual Studio Code

Use the dbaeumer.vscode-eslint extension that Microsoft provides officially.

You have to configure the "eslint.options".overrideConfigFile option of the extension to apply the configuration to the editor.

Example .vscode/settings.json:

{
  "eslint.options": {
    "overrideConfigFile": "./path/to/apply-only-to-editor.eslintrc.js"
  }
}

:white_check_mark: Rules

:wrench: Indicates that the rule is fixable, and using --fix option on the command line can automatically fix some of the reported problems.
:bulb: Indicates that some problems reported by the rule are manually fixable by editor suggestions.
:star: Indicates that the rule is included in the plugin:eslint-rule-tester/recommended config.

Possible Errors

These rules relate to possible syntax or logic errors:

| Rule ID | Description | | |:--------|:------------|:---| | eslint-rule-tester/valid-testcase | require match the invalid test case with the result. | :star::wrench: |

:beers: Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

See also CONTRIBUTING.md

:lock: License

See the LICENSE file for license rights and limitations (MIT).