fix(lint): Suppress global type clash between Jest and Cypress #282
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Maybe worth mentioning in the readme? |
mattcompiles
approved these changes
Jan 24, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cypress installs global type definitions for Mocha which clash with Jest's globals, which means that
sku lintfails for any consumer that also depends on Cypress.Unfortunately, due to the nature of globals (😞), there's no easy way to solve the underlying issue, but a workaround is to enable the
skipLibCheckflag on the TypeScript compiler (https://github.com/Microsoft/TypeScript-wiki/blob/master/What's-new-in-TypeScript.md#new---skiplibcheck).When applying this workaround, the global types for Jest are still resolved correctly in
*.test.tsx/*.test.tsxfiles. If consumers want to use TypeScript in their Cypress tests, they'll likely need to provide a customtsconfig.jsonin their Cypress subdirectory.