eslint-plugin-corefw

An eslint plugin to enforce custom rules used by the Core Framework.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-corefw:

$ npm install eslint-plugin-corefw --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-corefw globally.

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

{
    "plugins": [
        "@corefw/eslint-plugin-corefw"
    ]
}

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

{
    "rules": {
        "@corefw/corefw/rule-name": 2
    }
}