Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding guide around clashing types with Jest #5514

Merged
merged 2 commits into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/guides/references/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
jennifer-shehane marked this conversation as resolved.
Show resolved Hide resolved
[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)
Expand Down
13 changes: 13 additions & 0 deletions docs/guides/tooling/typescript-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
jennifer-shehane marked this conversation as resolved.
Show resolved Hide resolved
[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`
Expand Down