Skip to content
This repository has been archived by the owner on Aug 4, 2020. It is now read-only.

Commit

Permalink
Merge pull request #11 from pascalduez/pr__fix-readme
Browse files Browse the repository at this point in the history
Improve the Readme
  • Loading branch information
jquense committed Aug 18, 2015
2 parents ef054b8 + b335540 commit 1197501
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# eslint-plugin-babel

An eslint plugin companion to babel-eslint. babel-eslint does a great job of adapting eslint for use with Babel, but to it can't change the built in rules to support experimental features. eslint-plugin-babel reimplements problematic rules so they do not give false positives or negatives.
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` reimplements problematic rules so they do not give false positives or negatives.

### Install

```sh
npm install eslint-plugin-babel -S
npm install eslint-plugin-babel -D
```

enable the plugin by adjusting your `.eslintrc` file to include the plugin:
Load the plugin in your `.eslintrc` file:

```json
{
Expand All @@ -18,7 +18,8 @@ enable the plugin by adjusting your `.eslintrc` file to include the plugin:
}
```

Finally enable all the rules you like to use (remember to disable the originals as well!).
Finally enable all the rules you would like to use (remember to disable the
original ones as well!).

```json
{
Expand All @@ -33,10 +34,10 @@ Finally enable all the rules you like to use (remember to disable the originals
```
### Rules

Each rule cooresponds to a core eslint rule, and has the same options.
Each rule corresponds to a core `eslint` rule, and has the same options.

- `babel/generator-star-spacing`: Handles async/await functions correctly
- `babel/new-cap`: Ignores capitalized decorators (`@Decorator`)
- `babel/object-curly-spacing`: doesn't complain about `export x from "mod";` or `export * as x from "mod";`
- `babel/object-shorthand`: doesn't fail when using object spread (`...obj`)
- `babel/arrow-parens`: Handles async functions correctly
- `babel/arrow-parens`: Handles async functions correctly

0 comments on commit 1197501

Please sign in to comment.