mirror of
https://github.com/datahub-project/datahub.git
synced 2025-10-12 09:25:23 +00:00
52 lines
1.0 KiB
Markdown
52 lines
1.0 KiB
Markdown
|
# @datahub/eslint-plugin
|
||
|
|
|
||
|
|
Custom ES-Lint rules for datahub.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
You should not worry about this, since the scope of this addon is aimed only for @datahub and should be already installed. But just in case you wonder:
|
||
|
|
|
||
|
|
You'll first need to install [ESLint](http://eslint.org):
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm i eslint --save-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
Next, install `@datahub/eslint-plugin`:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install @datahub/eslint-plugin --save-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `@datahub/eslint-plugin` globally.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Add `@datahub` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin` part:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"plugins": [
|
||
|
|
"@datahub"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
Then configure the rules you want to use under the rules section.
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"rules": {
|
||
|
|
"@datahub/no-addon-import": "error"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Supported Rules
|
||
|
|
|
||
|
|
* Fill in provided rules here
|
||
|
|
|
||
|
|
["@datahub/no-addon-import"](docs/rules/no-addon-import.md)
|
||
|
|
|
||
|
|
["@datahub/no-linkedin-import"](docs/rules/no-linkedin-import.md)
|