diff --git a/CHANGELOG.md b/CHANGELOG.md index b3478f5ba123..c20e4d2a0c4d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,7 @@ - `[*]` [**BREAKING**] Drop support for Node v12 and v17 ([#13033](https://github.com/facebook/jest/pull/13033)) - `[docs]` Fix webpack name ([#13049](https://github.com/facebook/jest/pull/13049)) +- `[docs]` Explicit how to set `n` for `--bail` ([#13128](https://github.com/facebook/jest/pull/13128)) - `[jest-leak-detector]` Remove support for `weak-napi` ([#13035](https://github.com/facebook/jest/pull/13035)) ### Performance diff --git a/docs/CLI.md b/docs/CLI.md index b070f975a2dd..bca78b1ca5b3 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -118,7 +118,7 @@ import TOCInline from '@theme/TOCInline'; When you run `jest` with an argument, that argument is treated as a regular expression to match against files in your project. It is possible to run test suites by providing a pattern. Only the files that the pattern matches will be picked up and executed. Depending on your terminal, you may need to quote this argument: `jest "my.*(complex)?pattern"`. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`. -### `--bail` +### `--bail[=]` Alias: `-b`. Exit the test suite immediately upon `n` number of failing test suite. Defaults to `1`. diff --git a/website/versioned_docs/version-25.x/CLI.md b/website/versioned_docs/version-25.x/CLI.md index 5fbd6b2f4efe..bb8699c730ca 100644 --- a/website/versioned_docs/version-25.x/CLI.md +++ b/website/versioned_docs/version-25.x/CLI.md @@ -116,7 +116,7 @@ import TOCInline from '@theme/TOCInline'; When you run `jest` with an argument, that argument is treated as a regular expression to match against files in your project. It is possible to run test suites by providing a pattern. Only the files that the pattern matches will be picked up and executed. Depending on your terminal, you may need to quote this argument: `jest "my.*(complex)?pattern"`. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`. -### `--bail` +### `--bail[=]` Alias: `-b`. Exit the test suite immediately upon `n` number of failing test suite. Defaults to `1`. diff --git a/website/versioned_docs/version-26.x/CLI.md b/website/versioned_docs/version-26.x/CLI.md index 616edf089126..186a52075e0e 100644 --- a/website/versioned_docs/version-26.x/CLI.md +++ b/website/versioned_docs/version-26.x/CLI.md @@ -112,7 +112,7 @@ import TOCInline from '@theme/TOCInline'; When you run `jest` with an argument, that argument is treated as a regular expression to match against files in your project. It is possible to run test suites by providing a pattern. Only the files that the pattern matches will be picked up and executed. Depending on your terminal, you may need to quote this argument: `jest "my.*(complex)?pattern"`. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`. -### `--bail` +### `--bail[=]` Alias: `-b`. Exit the test suite immediately upon `n` number of failing test suite. Defaults to `1`. diff --git a/website/versioned_docs/version-27.x/CLI.md b/website/versioned_docs/version-27.x/CLI.md index 4e4602e4d99f..a4e640157cd9 100644 --- a/website/versioned_docs/version-27.x/CLI.md +++ b/website/versioned_docs/version-27.x/CLI.md @@ -112,7 +112,7 @@ import TOCInline from '@theme/TOCInline'; When you run `jest` with an argument, that argument is treated as a regular expression to match against files in your project. It is possible to run test suites by providing a pattern. Only the files that the pattern matches will be picked up and executed. Depending on your terminal, you may need to quote this argument: `jest "my.*(complex)?pattern"`. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`. -### `--bail` +### `--bail[=]` Alias: `-b`. Exit the test suite immediately upon `n` number of failing test suite. Defaults to `1`. diff --git a/website/versioned_docs/version-28.0/CLI.md b/website/versioned_docs/version-28.0/CLI.md index b070f975a2dd..bca78b1ca5b3 100644 --- a/website/versioned_docs/version-28.0/CLI.md +++ b/website/versioned_docs/version-28.0/CLI.md @@ -118,7 +118,7 @@ import TOCInline from '@theme/TOCInline'; When you run `jest` with an argument, that argument is treated as a regular expression to match against files in your project. It is possible to run test suites by providing a pattern. Only the files that the pattern matches will be picked up and executed. Depending on your terminal, you may need to quote this argument: `jest "my.*(complex)?pattern"`. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`. -### `--bail` +### `--bail[=]` Alias: `-b`. Exit the test suite immediately upon `n` number of failing test suite. Defaults to `1`. diff --git a/website/versioned_docs/version-28.1/CLI.md b/website/versioned_docs/version-28.1/CLI.md index b070f975a2dd..bca78b1ca5b3 100644 --- a/website/versioned_docs/version-28.1/CLI.md +++ b/website/versioned_docs/version-28.1/CLI.md @@ -118,7 +118,7 @@ import TOCInline from '@theme/TOCInline'; When you run `jest` with an argument, that argument is treated as a regular expression to match against files in your project. It is possible to run test suites by providing a pattern. Only the files that the pattern matches will be picked up and executed. Depending on your terminal, you may need to quote this argument: `jest "my.*(complex)?pattern"`. On Windows, you will need to use `/` as a path separator or escape `\` as `\\`. -### `--bail` +### `--bail[=]` Alias: `-b`. Exit the test suite immediately upon `n` number of failing test suite. Defaults to `1`.