Skip to content

Commit

Permalink
Docs: Add plugin example to disabling with comments guide (fixes #6742)…
Browse files Browse the repository at this point in the history
… (#6747)
  • Loading branch information
btmills authored and ilyavolodin committed Jul 28, 2016
1 parent 628aae4 commit 1025772
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/user-guide/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,12 @@ alert('foo'); // eslint-disable-line no-alert, quotes, semi
alert('foo');
```

All of the above methods also work for plugin rules. For example, to disable `eslint-plugin-example`'s `rule-name` rule, combine the plugin's name (`example`) and the rule's name (`rule-name`) into `example/rule-name`:

```js
foo(); // eslint-disable-line example/rule-name
```

**Note:** Comments that disable warnings for a portion of a file tell ESLint not to report rule violations for the disabled code. ESLint still parses the entire file, however, so disabled code still needs to be syntactically valid JavaScript.

## Adding Shared Settings
Expand Down

0 comments on commit 1025772

Please sign in to comment.