Skip to content

Commit

Permalink
docs(eslint-plugin): Add eslint:recommended to a usage example (#591)
Browse files Browse the repository at this point in the history
  • Loading branch information
borekb authored and bradzacher committed Jun 6, 2019
1 parent 861844d commit c03b6ed
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion packages/eslint-plugin/README.md
Expand Up @@ -43,14 +43,26 @@ Then configure the rules you want to use under the rules section.
}
```

You can also enable all the recommended rules at once. Add `plugin:@typescript-eslint/recommended` in extends:
You can also enable all the recommended rules for our plugin. Add `plugin:@typescript-eslint/recommended` in extends:

```json
{
"extends": ["plugin:@typescript-eslint/recommended"]
}
```

You can also use [eslint:recommended](https://eslint.org/docs/rules/) with this plugin. Add both `eslint:recommended` and `plugin:@typescript-eslint/eslint-recommended`:

```json
{
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
]
}
```

If you want to use rules which require type information, you will need to specify a path to your tsconfig.json file in the "project" property of "parserOptions".

```json
Expand Down

0 comments on commit c03b6ed

Please sign in to comment.