From a2d574886d7603bf4b2a2e7490a0f1710029a954 Mon Sep 17 00:00:00 2001 From: Adrien Dorsaz Date: Fri, 12 Aug 2022 22:42:42 +0200 Subject: [PATCH] explicit how to set `n` parameter to `--bail` The equal sign is required between `--bail` and `n`, otherwise the number `n` will be used as a test file filter. --- CHANGELOG.md | 1 + docs/CLI.md | 2 +- website/versioned_docs/version-25.x/CLI.md | 2 +- website/versioned_docs/version-26.x/CLI.md | 2 +- website/versioned_docs/version-27.x/CLI.md | 2 +- website/versioned_docs/version-28.0/CLI.md | 2 +- website/versioned_docs/version-28.1/CLI.md | 2 +- 7 files changed, 7 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 02d6f94c4885..482e20c5e4f1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,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..6b9d08aa861b 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=n` 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..5b37a70417d9 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=n` 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..9114095b5b27 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=n` 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..917d914fc32c 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=n` 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..6b9d08aa861b 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=n` 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..6b9d08aa861b 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=n` Alias: `-b`. Exit the test suite immediately upon `n` number of failing test suite. Defaults to `1`.