# eslint-plugin-file-banner

> Eslint plugin to verify file banner

Latest version **1.0.0** (published 2017-02-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-file-banner
pnpm add eslint-plugin-file-banner
yarn add eslint-plugin-file-banner
bun add eslint-plugin-file-banner
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-02-16 |
| First published | 2017-02-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.5.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Denys Karpenko |
| Maintainers | denysk |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-file-banner
- Repository: https://github.com/screamy/eslint-plugin-file-banner
- Homepage: https://github.com/screamy/eslint-plugin-file-banner#readme
- Issues: https://github.com/screamy/eslint-plugin-file-banner/issues
- npm.io page: https://npm.io/package/eslint-plugin-file-banner

## Dependencies (2)

- [doctrine](https://npm.io/package/doctrine.md) ^2.0.0
- [requireindex](https://npm.io/package/requireindex.md) ~1.1.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-02-16

## README

# eslint-plugin-file-banner

Eslint plugin to check file has comment block and  jsdoc tags

## Installation

You'll first need to install [ESLint](http://eslint.org):

```
$ 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:

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


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

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

## Supported Rules

- [banner](docs/rules/banner.md): Analyze file banner

---
_Source: https://npm.io/package/eslint-plugin-file-banner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._