From a4bdf96008ac4a76eee57df6cf5b3dd2e290a5ea Mon Sep 17 00:00:00 2001 From: ArkadyDR Date: Tue, 29 Sep 2020 22:13:57 +0800 Subject: [PATCH] docs: Document `--testFailureExitCode` (#10542) --- docs/Configuration.md | 8 ++++++++ website/versioned_docs/version-22.x/Configuration.md | 8 ++++++++ website/versioned_docs/version-23.x/Configuration.md | 8 ++++++++ website/versioned_docs/version-24.x/Configuration.md | 8 ++++++++ website/versioned_docs/version-25.x/Configuration.md | 8 ++++++++ website/versioned_docs/version-26.0/Configuration.md | 8 ++++++++ website/versioned_docs/version-26.2/Configuration.md | 8 ++++++++ website/versioned_docs/version-26.4/Configuration.md | 8 ++++++++ 8 files changed, 64 insertions(+) diff --git a/docs/Configuration.md b/docs/Configuration.md index c1fbe728e023..9e485fcafc34 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1032,6 +1032,14 @@ Default: `{}` Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`. +### `testFailureExitCode` [number] + +Default: `1` + +The exit code Jest returns on test failure. + +_Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration)._ + ### `testMatch` [array\] (default: `[ "**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)" ]`) diff --git a/website/versioned_docs/version-22.x/Configuration.md b/website/versioned_docs/version-22.x/Configuration.md index 094f97023c9e..1b156ae7ab4f 100644 --- a/website/versioned_docs/version-22.x/Configuration.md +++ b/website/versioned_docs/version-22.x/Configuration.md @@ -718,6 +718,14 @@ Default: `{}` Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`. +### `testFailureExitCode` [number] + +Default: `1` + +The exit code Jest returns on test failure. + +_Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration)._ + ### `testMatch` [array\] (default: `[ '**/__tests__/**/*.js?(x)', '**/?(*.)(spec|test).js?(x)' ]`) diff --git a/website/versioned_docs/version-23.x/Configuration.md b/website/versioned_docs/version-23.x/Configuration.md index cfab16861d4b..e281fb4b8ff7 100644 --- a/website/versioned_docs/version-23.x/Configuration.md +++ b/website/versioned_docs/version-23.x/Configuration.md @@ -784,6 +784,14 @@ Default: `{}` Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`. +### `testFailureExitCode` [number] + +Default: `1` + +The exit code Jest returns on test failure. + +_Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration)._ + ### `testMatch` [array\] (default: `[ "**/__tests__/**/*.js?(x)", "**/?(*.)+(spec|test).js?(x)" ]`) diff --git a/website/versioned_docs/version-24.x/Configuration.md b/website/versioned_docs/version-24.x/Configuration.md index 0da1783ab9f7..072716ad96aa 100644 --- a/website/versioned_docs/version-24.x/Configuration.md +++ b/website/versioned_docs/version-24.x/Configuration.md @@ -946,6 +946,14 @@ Default: `{}` Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`. +### `testFailureExitCode` [number] + +Default: `1` + +The exit code Jest returns on test failure. + +_Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration)._ + ### `testMatch` [array\] (default: `[ "**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)" ]`) diff --git a/website/versioned_docs/version-25.x/Configuration.md b/website/versioned_docs/version-25.x/Configuration.md index b7ab1d921361..5166fe55febb 100644 --- a/website/versioned_docs/version-25.x/Configuration.md +++ b/website/versioned_docs/version-25.x/Configuration.md @@ -968,6 +968,14 @@ Default: `{}` Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`. +### `testFailureExitCode` [number] + +Default: `1` + +The exit code Jest returns on test failure. + +_Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration)._ + ### `testMatch` [array\] (default: `[ "**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)" ]`) diff --git a/website/versioned_docs/version-26.0/Configuration.md b/website/versioned_docs/version-26.0/Configuration.md index 7d0c0880f7b5..9963ab3274c8 100644 --- a/website/versioned_docs/version-26.0/Configuration.md +++ b/website/versioned_docs/version-26.0/Configuration.md @@ -968,6 +968,14 @@ Default: `{}` Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`. +### `testFailureExitCode` [number] + +Default: `1` + +The exit code Jest returns on test failure. + +_Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration)._ + ### `testMatch` [array\] (default: `[ "**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)" ]`) diff --git a/website/versioned_docs/version-26.2/Configuration.md b/website/versioned_docs/version-26.2/Configuration.md index 24a8b26c2c86..765476602498 100644 --- a/website/versioned_docs/version-26.2/Configuration.md +++ b/website/versioned_docs/version-26.2/Configuration.md @@ -984,6 +984,14 @@ Default: `{}` Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`. +### `testFailureExitCode` [number] + +Default: `1` + +The exit code Jest returns on test failure. + +_Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration)._ + ### `testMatch` [array\] (default: `[ "**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)" ]`) diff --git a/website/versioned_docs/version-26.4/Configuration.md b/website/versioned_docs/version-26.4/Configuration.md index 0a516470117a..15b255b04fee 100644 --- a/website/versioned_docs/version-26.4/Configuration.md +++ b/website/versioned_docs/version-26.4/Configuration.md @@ -1015,6 +1015,14 @@ Default: `{}` Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`. +### `testFailureExitCode` [number] + +Default: `1` + +The exit code Jest returns on test failure. + +_Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration)._ + ### `testMatch` [array\] (default: `[ "**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)" ]`)