Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/babel/eslint-plugin-babel
An ESlint rule plugin companion to babel-eslint
https://github.com/babel/eslint-plugin-babel
babel babel-eslint eslint eslint-plugin
Last synced: about 2 months ago
JSON representation
An ESlint rule plugin companion to babel-eslint
- Host: GitHub
- URL: https://github.com/babel/eslint-plugin-babel
- Owner: babel
- License: other
- Archived: true
- Created: 2015-06-19T00:50:43.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-07-31T17:01:40.000Z (about 4 years ago)
- Last Synced: 2024-05-21T18:06:49.723Z (4 months ago)
- Topics: babel, babel-eslint, eslint, eslint-plugin
- Language: JavaScript
- Homepage: https://github.com/babel/babel-eslint
- Size: 176 KB
- Stars: 390
- Watchers: 21
- Forks: 78
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-babel
## NOTE: eslint-plugin-babel is now `@babel/eslint-plugin` and has moved into the [Babel monorepo](https://github.com/babel/babel/tree/main/eslint/babel-eslint-plugin).
An `eslint` plugin companion to `babel-eslint`. `babel-eslint` does a great job at adapting `eslint`
for use with Babel, but it can't change the built in rules to support experimental features.
`eslint-plugin-babel` re-implements problematic rules so they do not give false positives or negatives.
> Requires Node 4 or greater
### Install
```sh
npm install eslint-plugin-babel --save-dev
```
Load the plugin in your `.eslintrc` file:
```json
{
"plugins": [
"babel"
]
}
```
Finally enable all the rules you would like to use (remember to disable the
original ones as well!).
```json
{
"rules": {
"babel/new-cap": 1,
"babel/camelcase": 1,
"babel/no-invalid-this": 1,
"babel/object-curly-spacing": 1,
"babel/quotes": 1,
"babel/semi": 1,
"babel/no-unused-expressions": 1,
"babel/valid-typeof": 1
}
}
```
### Rules
Each rule corresponds to a core `eslint` rule, and has the same options.
🛠: means it's autofixable with `--fix`.
- `babel/new-cap`: Ignores capitalized decorators (`@Decorator`)
- `babel/camelcase`: doesn't complain about optional chaining (`var foo = bar?.a_b;`)
- `babel/no-invalid-this`: doesn't fail when inside class properties (`class A { a = this.b; }`)
- `babel/object-curly-spacing`: doesn't complain about `export x from "mod";` or `export * as x from "mod";` (🛠)
- `babel/quotes`: doesn't complain about JSX fragment shorthand syntax (`<>foo>;`)
- `babel/semi`: doesn't fail when using `for await (let something of {})`. Includes class properties (🛠)
- `babel/no-unused-expressions`: doesn't fail when using `do` expressions or [optional chaining](https://github.com/tc39/proposal-optional-chaining) (`a?.b()`).
- `babel/valid-typeof`: doesn't complain when used with [BigInt](https://github.com/tc39/proposal-bigint) (`typeof BigInt(9007199254740991) === 'bigint'`).
#### Deprecated
| Rule | Notes |
|:---------------------------------|:-----------------------------------|
| `babel/generator-star-spacing` | Use [`generator-star-spacing`](http://eslint.org/docs/rules/generator-star-spacing) since [email protected] |
| `babel/object-shorthand` | Use [`object-shorthand`](http://eslint.org/docs/rules/object-shorthand) since [email protected] |
| `babel/arrow-parens` | Use [`arrow-parens`](http://eslint.org/docs/rules/arrow-parens) since [email protected] |
| `babel/func-params-comma-dangle` | Use [`comma-dangle`](http://eslint.org/docs/rules/comma-dangle) since [email protected] |
| `babel/array-bracket-spacing` | Use [`array-bracket-spacing`](http://eslint.org/docs/rules/array-bracket-spacing) since [email protected] |
| `babel/flow-object-type` | Use [`flowtype/object-type-delimiter`](https://github.com/gajus/eslint-plugin-flowtype#eslint-plugin-flowtype-rules-object-type-delimiter) since [email protected] |
| `babel/no-await-in-loop` | Use [`no-await-in-loop`](http://eslint.org/docs/rules/no-await-in-loop) since [email protected] |