add caution note to '.' usage in moduleDirectories

resolves #10498
jestjs · Feb 21, 2024 · 7be4e56 · 7be4e56
1 parent e6d60cb
commit 7be4e56
Showing 1 changed file with 6 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"]`