docs: add testEnvironmentOptions configuration examples (#13991)

jestjs · Mar 8, 2023 · 67aa05c · 67aa05c
1 parent 39f3bed
commit 67aa05c
Show file tree

Hide file tree

Showing 11 changed files with 445 additions and 11 deletions.
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -1908,10 +1908,64 @@ Default: `{}`
 
 Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment.
 
-For example, in `jest-environment-jsdom`, you can override options given to [`jsdom`](https://github.com/jsdom/jsdom) such as `{html: "<html lang="zh-cmn-Hant"></html>", url: 'https://jestjs.io/', userAgent: "Agent/007"}`.
+For example, you can override options passed to [`jsdom`](https://github.com/jsdom/jsdom):
+
+```js tab
+/** @type {import('jest').Config} */
+const config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+
+module.exports = config;
+```
+
+```ts tab
+import type {Config} from 'jest';
+
+const config: Config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+
+export default config;
+```
 
 Both `jest-environment-jsdom` and `jest-environment-node` allow specifying `customExportConditions`, which allow you to control which versions of a library are loaded from `exports` in `package.json`. `jest-environment-jsdom` defaults to `['browser']`. `jest-environment-node` defaults to `['node', 'node-addons']`.
 
+```js tab
+/** @type {import('jest').Config} */
+const config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+
+module.exports = config;
+```
+
+```ts tab
+import type {Config} from 'jest';
+
+const config: Config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+
+export default config;
+```
+
 These options can also be passed in a docblock, similar to `testEnvironment`. The string with options must be parseable by `JSON.parse`:
 
 ```js

diff --git a/website/versioned_docs/version-25.x/Configuration.md b/website/versioned_docs/version-25.x/Configuration.md
@@ -1100,7 +1100,19 @@ beforeAll(() => {
 
 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"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment.
+
+For example, you can override options passed to [`jsdom`](https://github.com/jsdom/jsdom):
+
+```js
+module.exports = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ userAgent: 'Agent/007',
+ },
+};
+```
 
 ### `testFailureExitCode` \[number]
 

diff --git a/website/versioned_docs/version-26.x/Configuration.md b/website/versioned_docs/version-26.x/Configuration.md
@@ -1186,7 +1186,19 @@ beforeAll(() => {
 
 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"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment.
+
+For example, you can override options passed to [`jsdom`](https://github.com/jsdom/jsdom):
+
+```js
+module.exports = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ userAgent: 'Agent/007',
+ },
+};
+```
 
 ### `testFailureExitCode` \[number]
 

diff --git a/website/versioned_docs/version-27.x/Configuration.md b/website/versioned_docs/version-27.x/Configuration.md
@@ -1256,7 +1256,19 @@ beforeAll(() => {
 
 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 `{html: "<html lang="zh-cmn-Hant"></html>", userAgent: "Agent/007"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment.
+
+For example, you can override options passed to [`jsdom`](https://github.com/jsdom/jsdom):
+
+```js
+module.exports = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ userAgent: 'Agent/007',
+ },
+};
+```
 
 ### `testFailureExitCode` \[number]
 

diff --git a/website/versioned_docs/version-28.x/Configuration.md b/website/versioned_docs/version-28.x/Configuration.md
@@ -1393,10 +1393,30 @@ Default: `{}`
 
 Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment.
 
-For example, in `jest-environment-jsdom`, you can override options given to [`jsdom`](https://github.com/jsdom/jsdom) such as `{html: "<html lang="zh-cmn-Hant"></html>", url: 'https://jestjs.io/', userAgent: "Agent/007"}`.
+For example, you can override options passed to [`jsdom`](https://github.com/jsdom/jsdom):
+
+```js
+module.exports = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+```
 
 Both `jest-environment-jsdom` and `jest-environment-node` allow specifying `customExportConditions`, which allow you to control which versions of a library are loaded from `exports` in `package.json`. `jest-environment-jsdom` defaults to `['browser']`. `jest-environment-node` defaults to `['node', 'node-addons']`.
 
+```js
+module.exports = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+```
+
 These options can also be passed in a docblock, similar to `testEnvironment`. The string with options must be parseable by `JSON.parse`:
 
 ```js

diff --git a/website/versioned_docs/version-29.0/Configuration.md b/website/versioned_docs/version-29.0/Configuration.md
@@ -1867,10 +1867,64 @@ Default: `{}`
 
 Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment.
 
-For example, in `jest-environment-jsdom`, you can override options given to [`jsdom`](https://github.com/jsdom/jsdom) such as `{html: "<html lang="zh-cmn-Hant"></html>", url: 'https://jestjs.io/', userAgent: "Agent/007"}`.
+For example, you can override options passed to [`jsdom`](https://github.com/jsdom/jsdom):
+
+```js tab
+/** @type {import('jest').Config} */
+const config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+
+module.exports = config;
+```
+
+```ts tab
+import type {Config} from 'jest';
+
+const config: Config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+
+export default config;
+```
 
 Both `jest-environment-jsdom` and `jest-environment-node` allow specifying `customExportConditions`, which allow you to control which versions of a library are loaded from `exports` in `package.json`. `jest-environment-jsdom` defaults to `['browser']`. `jest-environment-node` defaults to `['node', 'node-addons']`.
 
+```js tab
+/** @type {import('jest').Config} */
+const config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+
+module.exports = config;
+```
+
+```ts tab
+import type {Config} from 'jest';
+
+const config: Config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+
+export default config;
+```
+
 These options can also be passed in a docblock, similar to `testEnvironment`. The string with options must be parseable by `JSON.parse`:
 
 ```js

diff --git a/website/versioned_docs/version-29.1/Configuration.md b/website/versioned_docs/version-29.1/Configuration.md
@@ -1867,10 +1867,64 @@ Default: `{}`
 
 Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment.
 
-For example, in `jest-environment-jsdom`, you can override options given to [`jsdom`](https://github.com/jsdom/jsdom) such as `{html: "<html lang="zh-cmn-Hant"></html>", url: 'https://jestjs.io/', userAgent: "Agent/007"}`.
+For example, you can override options passed to [`jsdom`](https://github.com/jsdom/jsdom):
+
+```js tab
+/** @type {import('jest').Config} */
+const config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+
+module.exports = config;
+```
+
+```ts tab
+import type {Config} from 'jest';
+
+const config: Config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+
+export default config;
+```
 
 Both `jest-environment-jsdom` and `jest-environment-node` allow specifying `customExportConditions`, which allow you to control which versions of a library are loaded from `exports` in `package.json`. `jest-environment-jsdom` defaults to `['browser']`. `jest-environment-node` defaults to `['node', 'node-addons']`.
 
+```js tab
+/** @type {import('jest').Config} */
+const config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+
+module.exports = config;
+```
+
+```ts tab
+import type {Config} from 'jest';
+
+const config: Config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+
+export default config;
+```
+
 These options can also be passed in a docblock, similar to `testEnvironment`. The string with options must be parseable by `JSON.parse`:
 
 ```js

diff --git a/website/versioned_docs/version-29.2/Configuration.md b/website/versioned_docs/version-29.2/Configuration.md
@@ -1873,10 +1873,64 @@ Default: `{}`
 
 Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment.
 
-For example, in `jest-environment-jsdom`, you can override options given to [`jsdom`](https://github.com/jsdom/jsdom) such as `{html: "<html lang="zh-cmn-Hant"></html>", url: 'https://jestjs.io/', userAgent: "Agent/007"}`.
+For example, you can override options passed to [`jsdom`](https://github.com/jsdom/jsdom):
+
+```js tab
+/** @type {import('jest').Config} */
+const config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+
+module.exports = config;
+```
+
+```ts tab
+import type {Config} from 'jest';
+
+const config: Config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ html: '<html lang="zh-cmn-Hant"></html>',
+ url: 'https://jestjs.io/',
+ userAgent: 'Agent/007',
+ },
+};
+
+export default config;
+```
 
 Both `jest-environment-jsdom` and `jest-environment-node` allow specifying `customExportConditions`, which allow you to control which versions of a library are loaded from `exports` in `package.json`. `jest-environment-jsdom` defaults to `['browser']`. `jest-environment-node` defaults to `['node', 'node-addons']`.
 
+```js tab
+/** @type {import('jest').Config} */
+const config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+
+module.exports = config;
+```
+
+```ts tab
+import type {Config} from 'jest';
+
+const config: Config = {
+ testEnvironment: 'jsdom',
+ testEnvironmentOptions: {
+ customExportConditions: ['react-native'],
+ },
+};
+
+export default config;
+```
+
 These options can also be passed in a docblock, similar to `testEnvironment`. The string with options must be parseable by `JSON.parse`:
 
 ```js