eslint-plugin-flynncao

Flynn Cao's ESLint Plugin for Demonstration.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-flynncao:

npm install eslint-plugin-flynncao --save-dev

Usage

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

{
    "plugins": [
        "flynncao"
    ]
}

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

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

Rules

| Name | Description | | :----------------------------------------------------- | :------------------------------------------------------- | | mandatory-comments | You should write some comments for this kind of function |