Adding guide around types with Jest

cypress-io · Oct 3, 2023 · 1c36175 · 1c36175
1 parent e0a1086
commit 1c36175
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx
@@ -1501,6 +1501,19 @@ respectively.
 Any previous dev servers or mounting libraries from the `@cypress` namespace
 should be uninstalled in Cypress 10.
 
+### Clashing Types with Jest
+
+You may want to consider configuring your app with separate `tsconfig.json` to solve
+[clashing types with jest](/guides/tooling/typescript-support#Clashing-types-with-Jest).
+You will need to exclude `cypress.config.ts`, `cypress`, `node_modules` in your
+root `tsconfig.json` file.
+
+```json
+{
+  "exclude": ["cypress.config.ts", "cypress", "node_modules"]
+}
+```
+
 ### Code Coverage Plugin
 
 The [Cypress Code Coverage](https://github.com/cypress-io/code-coverage#readme)

diff --git a/docs/guides/tooling/typescript-support.mdx b/docs/guides/tooling/typescript-support.mdx
@@ -71,6 +71,19 @@ If that does not work, try restarting the IDE.
 
 :::
 
+### Clashing Types with Jest
+
+You may want to consider configuring your app with separate `tsconfig.json` to solve
+[clashing types with jest](/guides/tooling/typescript-support#Clashing-types-with-Jest).
+You will need to exclude `cypress.config.ts`, `cypress`, `node_modules` in your
+root `tsconfig.json` file.
+
+```json
+{
+  "exclude": ["cypress.config.ts", "cypress", "node_modules"]
+}
+```
+
 ### Types for Custom Commands
 
 When adding [custom commands](/api/cypress-api/custom-commands) to the `cy`