docs: Add caution note to '.' usage in moduleDirectories (#14913)

jestjs · May 29, 2024 · 4280a31 · 4280a31
1 parent 68dca2a
commit 4280a31
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -938,6 +938,12 @@ const config: Config = {
 export default config;
 ```
 
+:::caution
+
+It is discouraged to use `'.'` as one of the `moduleDirectories`, because this prevents scoped packages such as `@emotion/react` from accessing packages with the same subdirectory name (`react`). See [this issue](https://github.com/jestjs/jest/issues/10498) for more details. In most cases, it is preferable to use the [moduleNameMapper](#modulenamemapper-objectstring-string--arraystring) configuration instead.
+
+:::
+
 ### `moduleFileExtensions` \[array&lt;string&gt;]
 
 Default: `["js", "mjs", "cjs", "jsx", "ts", "mts", "cts", "tsx", "json", "node"]`

diff --git a/website/versioned_docs/version-29.4/Configuration.md b/website/versioned_docs/version-29.4/Configuration.md
@@ -929,6 +929,12 @@ const config: Config = {
 export default config;
 ```
 
+:::caution
+
+It is discouraged to use `'.'` as one of the `moduleDirectories`, because this prevents scoped packages such as `@emotion/react` from accessing packages with the same subdirectory name (`react`). See [this issue](https://github.com/jestjs/jest/issues/10498) for more details. In most cases, it is preferable to use the [moduleNameMapper](#modulenamemapper-objectstring-string--arraystring) configuration instead.
+
+:::
+
 ### `moduleFileExtensions` \[array&lt;string&gt;]
 
 Default: `["js", "mjs", "cjs", "jsx", "ts", "tsx", "json", "node"]`

diff --git a/website/versioned_docs/version-29.5/Configuration.md b/website/versioned_docs/version-29.5/Configuration.md
@@ -929,6 +929,12 @@ const config: Config = {
 export default config;
 ```
 
+:::caution
+
+It is discouraged to use `'.'` as one of the `moduleDirectories`, because this prevents scoped packages such as `@emotion/react` from accessing packages with the same subdirectory name (`react`). See [this issue](https://github.com/jestjs/jest/issues/10498) for more details. In most cases, it is preferable to use the [moduleNameMapper](#modulenamemapper-objectstring-string--arraystring) configuration instead.
+
+:::
+
 ### `moduleFileExtensions` \[array&lt;string&gt;]
 
 Default: `["js", "mjs", "cjs", "jsx", "ts", "tsx", "json", "node"]`

diff --git a/website/versioned_docs/version-29.6/Configuration.md b/website/versioned_docs/version-29.6/Configuration.md
@@ -929,6 +929,12 @@ const config: Config = {
 export default config;
 ```
 
+:::caution
+
+It is discouraged to use `'.'` as one of the `moduleDirectories`, because this prevents scoped packages such as `@emotion/react` from accessing packages with the same subdirectory name (`react`). See [this issue](https://github.com/jestjs/jest/issues/10498) for more details. In most cases, it is preferable to use the [moduleNameMapper](#modulenamemapper-objectstring-string--arraystring) configuration instead.
+
+:::
+
 ### `moduleFileExtensions` \[array&lt;string&gt;]
 
 Default: `["js", "mjs", "cjs", "jsx", "ts", "tsx", "json", "node"]`

diff --git a/website/versioned_docs/version-29.7/Configuration.md b/website/versioned_docs/version-29.7/Configuration.md
@@ -929,6 +929,12 @@ const config: Config = {
 export default config;
 ```
 
+:::caution
+
+It is discouraged to use `'.'` as one of the `moduleDirectories`, because this prevents scoped packages such as `@emotion/react` from accessing packages with the same subdirectory name (`react`). See [this issue](https://github.com/jestjs/jest/issues/10498) for more details. In most cases, it is preferable to use the [moduleNameMapper](#modulenamemapper-objectstring-string--arraystring) configuration instead.
+
+:::
+
 ### `moduleFileExtensions` \[array&lt;string&gt;]
 
 Default: `["js", "mjs", "cjs", "jsx", "ts", "tsx", "json", "node"]`