eslint-plugin-file-banner v1.0.0

eslint-plugin-file-banner

Eslint plugin to check file has comment block and jsdoc tags

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-file-banner:

$ npm install eslint-plugin-file-banner --save-dev

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

Usage

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

{
    "plugins": [
        "file-banner"
    ]
}

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

{
    "rules": {
        "file-banner/rule-name": 2
    }
}

Supported Rules

• banner: Analyze file banner