/eslint-plugin-no-one-time-vars

Disallows one-time variables

Primary LanguageJavaScriptMozilla Public License 2.0MPL-2.0

eslint-plugin-no-one-time-vars

Disallows one-time variables

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-no-one-time-vars:

npm install eslint-plugin-no-one-time-vars --save-dev

Usage

Add no-one-time-vars to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["no-one-time-vars"]
}

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

{
  "rules": {
    "no-one-time-vars/no-one-time-vars": "error"
  }
}

To add an option to the rule configuration do the following:

{
  "rules": {
    "no-one-time-vars/no-one-time-vars": [
      "error",
      {
        "option-name": "option-value"
      }
    ]
  }
}

Supported Rules

  • no-one-time-vars

Supported Options

  • ignoredVariables
    • type: Array of strings
    • default: []
  • allowInsideCallback
    • type: Boolean
    • default: true
  • ignoreFunctionVariables
    • type: Boolean
    • default: true
  • ignoreArrayVariables
    • type: Boolean, Number
    • default: false
  • ignoreObjectVariables
    • type: Boolean
    • default: false
  • ignoreObjectDestructuring:
    • type: Boolean
    • default: false
  • ignoreExportedVariables:
    • type: Boolean
    • default: true