@bowery-valuation/eslint-plugin

Bowery Valuation's custom eslint rules

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install @bowery-valuation/eslint-plugin:

$ npm install @bowery-valuation/eslint-plugin --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install @bowery-valuation/eslint-plugin globally. Note: @typescript-eslint/parser is currently the only supported parser.

Usage

Add @bowery-valuation to the plugins section of your .eslintrc configuration file. Omit the eslint-plugin suffix:

{
    "plugins": [
        "@bowery-valuation"
    ]
}

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

{
    "rules": {
        "@bowery-valuation/rule-name": "error"
    }
}

Supported Rules

See the docs folder for a list of supported rules.