Skip to content

Commit

Permalink
Docs: --no-ignore disables all forms of ignore (fixes #6260) (#6304)
Browse files Browse the repository at this point in the history
  • Loading branch information
alberto authored and nzakas committed Jun 1, 2016
1 parent bb69380 commit 38dccdd
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/developer-guide/nodejs-api.md
Expand Up @@ -156,7 +156,7 @@ The `CLIEngine` is a constructor, and you can create a new instance by passing i
* `extensions` - An array of filename extensions that should be checked for code. The default is an array containing just `".js"`. Corresponds to `--ext`.
* `globals` - An array of global variables to declare (default: empty array). Corresponds to `--global`.
* `fix` - True indicates that fixes should be applied to the text when possible.
* `ignore` - False disables use of `.eslintignore` (default: true). Corresponds to `--no-ignore`.
* `ignore` - False disables use of `.eslintignore`, `ignorePath` and `ignorePattern` (default: true). Corresponds to `--no-ignore`.
* `ignorePath` - The ignore file to use instead of `.eslintignore` (default: null). Corresponds to `--ignore-path`.
* `ignorePattern` - Glob patterns for paths to ignore. String or array of strings.
* `baseConfig` - Set to false to disable use of base config. Could be set to an object to override default base config as well.
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/command-line-interface.md
Expand Up @@ -50,7 +50,7 @@ Specifying rules and plugins:
Ignoring files:
--ignore-path path::String Specify path of ignore file
--no-ignore Disable use of .eslintignore
--no-ignore Disable use of ignore files and patterns
--ignore-pattern [String] Patterns of files to ignore (in addition to those
in .eslintignore)
Expand Down Expand Up @@ -235,7 +235,7 @@ Example:

#### `--no-ignore`

Disables excluding of files from `.eslintignore` and `--ignore-path` files.
Disables excluding of files from `.eslintignore`, `--ignore-path` and `--ignore-pattern`.

Example:

Expand Down
2 changes: 1 addition & 1 deletion lib/options.js
Expand Up @@ -114,7 +114,7 @@ module.exports = optionator({
option: "ignore",
type: "Boolean",
default: "true",
description: "Disable use of .eslintignore"
description: "Disable use of ignore files and patterns"
},
{
option: "ignore-pattern",
Expand Down

0 comments on commit 38dccdd

Please sign in to comment.