eslint-plugin-starton-plugin

Plugin written to get a excellent code style on the starton project _.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-starton-plugin:

npm install eslint-plugin-starton-plugin --save-dev

Usage

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

{
    "plugins": [
        "starton-plugin"
    ]
}

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

{
    "rules": {
        "starton-plugin/rule-name": 2
    }
}

Configurations

TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).

Rules

TODO: Run eslint-doc-generator to generate the rules list.