https://github.com/eirikurn/eslint-plugin-flow-header
Check existance of flow header comment.
https://github.com/eirikurn/eslint-plugin-flow-header
eslint flowtype
Last synced: about 1 month ago
JSON representation
Check existance of flow header comment.
- Host: GitHub
- URL: https://github.com/eirikurn/eslint-plugin-flow-header
- Owner: eirikurn
- Created: 2017-01-18T00:57:46.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-02-15T13:26:29.000Z (about 7 years ago)
- Last Synced: 2025-09-05T22:52:55.886Z (6 months ago)
- Topics: eslint, flowtype
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 9
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-plugin-flow-header
Check existance of flow header comment.
**NOTE**: This package is deprecated in favor of the [`require-valid-file-annotation`](https://github.com/gajus/eslint-plugin-flowtype#require-valid-file-annotation) rule in [eslint-plugin-flowtype](https://github.com/gajus/eslint-plugin-flowtype).
## Installation
You'll first need to install [ESLint](http://eslint.org):
```
$ npm i eslint --save-dev
```
Next, install `eslint-plugin-flow-header`:
```
$ npm install eslint-plugin-flow-header --save-dev
```
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-flow-header` globally.
## Usage
Add `flow-header` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
```json
{
"plugins": [
"flow-header"
]
}
```
Then configure the rules you want to use under the rules section.
```json
{
"rules": {
"flow-header/flow-header": 2
}
}
```
## Supported Rules
* [flow-header](docs/rules/flow-header.md)