npm.io
0.0.8 • Published 3 years ago

eslint-plugin-magic-variables

Licence
ISC
Version
0.0.8
Deps
4
Size
10 kB
Vulns
0
Weekly
0

eslint-plugin-magic-variables

Prevent variable names that are numeric, or are the word form of a number from being used. i.e. FIFTY_TWO is not a valid variable name.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-magic-variables:

npm install eslint-plugin-magic-variables --save-dev

Usage

Add magic-variables to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "magic-variables"
    ]
}

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

{
    "rules": {
        "magic-variables/rule-name": 2
    }
}

Rules

Name Description
no-magic-variables prevent magic numbers from being used as a variable name

Keywords