eslint-plugin-kpmg

A rule set for Eslint based on KPMG standard.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-kpmg:

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

Usage

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

{
    "plugins": [
        "kpmg"
    ]
}

or Just extend the recommand rule set,currently only support the vue rule set.

     extends: ["some other plugins","plugin:kpmg/vue"],

Then configure the rules you want to use under the rules section,(when you are using extend this would be optional).

{
    "rules": {
            "kpmg/no-simple-naming": [1, 3],
            "kpmg/single-file-too-large": [1, 500],
            "kpmg/no-sensitive-variable": [1, "password"]

    }
}

Supported Rules

| Rule | Description | |:--|:--| | no-simple-naming | do not use too simple names when define a variable name | | single-file-too-large | code lines should not too large in a single file | | no-sensitive-variable | do not use sensitive names in source code |

License

MIT

how to Contribute

Please refer the Eslint development guide and KPMG standard