Skip to content

Commit

Permalink
docs: Clarify CLI param testPathIgnorePatterns usage (#11304)
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin-brotcke committed Apr 30, 2021
1 parent c900f59 commit d13e177
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
6 changes: 4 additions & 2 deletions docs/CLI.md
Expand Up @@ -321,9 +321,11 @@ Note that `column` is 0-indexed while `line` is not.

A regexp pattern string that is matched against all tests paths before executing the test. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`.

### `--testPathIgnorePatterns=[array]`
### `--testPathIgnorePatterns=<regex>|[array]`

An array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to `--testPathPattern`, it will only run those tests with a path that does not match with the provided regexp expressions.
A single or array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to `--testPathPattern`, it will only run those tests with a path that does not match with the provided regexp expressions.

To pass as an array use escaped parentheses and space delimited regexps such as `\(/node_modules/ /tests/e2e/\)`. Alternatively, you can omit parentheses by combining regexps into a single regexp like `/node_modules/|/tests/e2e/`. These two examples are equivalent.

### `--testRunner=<path>`

Expand Down
6 changes: 4 additions & 2 deletions website/versioned_docs/version-25.x/CLI.md
Expand Up @@ -305,9 +305,11 @@ Note that `column` is 0-indexed while `line` is not.

A regexp pattern string that is matched against all tests paths before executing the test. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`.

### `--testPathIgnorePatterns=[array]`
### `--testPathIgnorePatterns=<regex>|[array]`

An array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to `--testPathPattern`, it will only run those tests with a path that does not match with the provided regexp expressions.
A single or array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to `--testPathPattern`, it will only run those tests with a path that does not match with the provided regexp expressions.

To pass as an array use escaped parentheses and space delimited regexps such as `\(/node_modules/ /tests/e2e/\)`. Alternatively, you can omit parentheses by combining regexps into a single regexp like `/node_modules/|/tests/e2e/`. These two examples are equivalent.

### `--testRunner=<path>`

Expand Down
6 changes: 4 additions & 2 deletions website/versioned_docs/version-26.x/CLI.md
Expand Up @@ -321,9 +321,11 @@ Note that `column` is 0-indexed while `line` is not.

A regexp pattern string that is matched against all tests paths before executing the test. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`.

### `--testPathIgnorePatterns=[array]`
### `--testPathIgnorePatterns=<regex>|[array]`

An array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to `--testPathPattern`, it will only run those tests with a path that does not match with the provided regexp expressions.
A single or array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to `--testPathPattern`, it will only run those tests with a path that does not match with the provided regexp expressions.

To pass as an array use escaped parentheses and space delimited regexps such as `\(/node_modules/ /tests/e2e/\)`. Alternatively, you can omit parentheses by combining regexps into a single regexp like `/node_modules/|/tests/e2e/`. These two examples are equivalent.

### `--testRunner=<path>`

Expand Down

0 comments on commit d13e177

Please sign in to comment.