epf

eslint-plugin-file-banner

Eslint plugin to verify file banner

Showing:

Popularity

Downloads/wk

0

GitHub Stars

0

Maintenance

Last Commit

5yrs ago

Contributors

0

Package

Dependencies

2

Size (min+gzip)

0.6KB

License

ISC

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial