Skip to content

MatanYadaev/eslint-plugin-testing

Repository files navigation

eslint-plugin-testing

npm ci

ESLint plugin for testing.

Installation

  1. First, install ESLint:

    npm install --save-dev eslint
  2. Next, install eslint-plugin-testing:

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

Usage

Add testing to the plugins section of your .eslintrc configuration file:

{
  "plugins": ["testing"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "testing/aaa-comments": "error"
  }
}

Recommended

To use the recommended configuration, extend it in your .eslintrc file:

{
  "extends": ["plugin:testing/recommended"]
}

All recommend rules will be set to error by default. You can however disable some rules by setting turning them off in your .eslintrc file or by setting them to warn in your .eslintrc.

All

To use the all configuration, extend it in your .eslintrc file:

{
  "extends": ["plugin:testing/all"]
}

Rules

💼 Configurations enabled in.
⚠️ Configurations set to warn in.
🌐 Set in the all configuration.
✅ Set in the recommended configuration.

Name Description 💼 ⚠️
aaa-comments Enforce AAA comments 🌐

Licence

MIT

Copyright © 2023-present, Matan Yadaev