Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 795 Bytes

README.md

File metadata and controls

51 lines (31 loc) · 795 Bytes

eslint-plugin-checkup

A purpose-built eslint plugin for use with Checkup CLI

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-checkup:

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

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

Usage

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

{
    "plugins": [
        "checkup"
    ]
}

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

{
    "rules": {
        "checkup/rule-name": 2
    }
}

Supported Rules

  • Fill in provided rules here