Skip to content

Commit

Permalink
docs: mention rootDir changes when using projects (#12871)
Browse files Browse the repository at this point in the history
  • Loading branch information
kettanaito committed Sep 17, 2022
1 parent 60e6870 commit 264a116
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/Configuration.md
Expand Up @@ -1208,6 +1208,12 @@ When using multi-project runner, it's recommended to add a `displayName` for eac

:::

:::note

With the `projects` option enabled, Jest will copy the root-level configuration options to each individual child configuration during the test run, resolving its values in the child's context. This means that string tokens like `<rootDir>` will point to the _child's root directory_ even if they are defined in the root-level configuration.

:::

### `reporters` \[array&lt;moduleName | \[moduleName, options]&gt;]

Default: `undefined`
Expand Down
6 changes: 6 additions & 0 deletions website/versioned_docs/version-25.x/Configuration.md
Expand Up @@ -693,6 +693,12 @@ When using multi-project runner, it's recommended to add a `displayName` for eac

:::

:::note

With the `projects` option enabled, Jest will copy the root-level configuration options to each individual child configuration during the test run, resolving its values in the child's context. This means that string tokens like `<rootDir>` will point to the _child's root directory_ even if they are defined in the root-level configuration.

:::

### `reporters` \[array&lt;moduleName | \[moduleName, options]&gt;]

Default: `undefined`
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-26.x/Configuration.md
Expand Up @@ -680,6 +680,8 @@ The projects feature can also be used to run multiple configurations or multiple

_Note: When using multi-project runner, it's recommended to add a `displayName` for each project. This will show the `displayName` of a project next to its tests._

_Note: With the `projects` option enabled, Jest will copy the root-level configuration options to each individual child configuration during the test run, resolving its values in the child's context. This means that string tokens like `<rootDir>` will point to the *child's root directory* even if they are defined in the root-level configuration._

### `reporters` \[array&lt;moduleName | \[moduleName, options]&gt;]

Default: `undefined`
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-27.x/Configuration.md
Expand Up @@ -707,6 +707,8 @@ The projects feature can also be used to run multiple configurations or multiple

_Note: When using multi-project runner, it's recommended to add a `displayName` for each project. This will show the `displayName` of a project next to its tests._

_Note: With the `projects` option enabled, Jest will copy the root-level configuration options to each individual child configuration during the test run, resolving its values in the child's context. This means that string tokens like `<rootDir>` will point to the *child's root directory* even if they are defined in the root-level configuration._

### `reporters` \[array&lt;moduleName | \[moduleName, options]&gt;]

Default: `undefined`
Expand Down
6 changes: 6 additions & 0 deletions website/versioned_docs/version-28.x/Configuration.md
Expand Up @@ -844,6 +844,12 @@ When using multi-project runner, it's recommended to add a `displayName` for eac

:::

:::note

With the `projects` option enabled, Jest will copy the root-level configuration options to each individual child configuration during the test run, resolving its values in the child's context. This means that string tokens like `<rootDir>` will point to the _child's root directory_ even if they are defined in the root-level configuration.

:::

### `reporters` \[array&lt;moduleName | \[moduleName, options]&gt;]

Default: `undefined`
Expand Down
6 changes: 6 additions & 0 deletions website/versioned_docs/version-29.0/Configuration.md
Expand Up @@ -1208,6 +1208,12 @@ When using multi-project runner, it's recommended to add a `displayName` for eac

:::

:::note

With the `projects` option enabled, Jest will copy the root-level configuration options to each individual child configuration during the test run, resolving its values in the child's context. This means that string tokens like `<rootDir>` will point to the _child's root directory_ even if they are defined in the root-level configuration.

:::

### `reporters` \[array&lt;moduleName | \[moduleName, options]&gt;]

Default: `undefined`
Expand Down

0 comments on commit 264a116

Please sign in to comment.