Skip to content
This repository was archived by the owner on Jan 19, 2019. It is now read-only.

Commit e2f50e8

Browse files
authored
[DOCS][no-unused-vars] improve documentation (#172)
1 parent 81a8a48 commit e2f50e8

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/rules/no-unused-vars.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
# Prevent TypeScript-specific constructs from being erroneously flagged as unused (no-unused-vars)
22

3-
This rule only has an effect when the `no-unused-vars` core rule is enabled.
4-
53
It ensures that TypeScript-specific constructs, such as implemented interfaces, are not erroneously flagged as unused.
64

5+
## Configuration
6+
7+
***This rule only has an effect when the `no-unused-vars` core rule is enabled.***
8+
9+
See [the core ESLint docs](https://eslint.org/docs/rules/no-unused-vars) for how to configure the base `no-unused-vars` rule.
10+
11+
```JSON
12+
{
13+
"rules": {
14+
"no-unused-vars": "error",
15+
"typescript/no-unused-vars": "error",
16+
}
17+
}
18+
```
719
## Rule Details
820

921
The following patterns are considered warnings:

0 commit comments

Comments
 (0)