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

include CLI TS types in a way to avoid clashing with Jest #7352

Merged
merged 9 commits into from
May 15, 2020

Conversation

bahmutov
Copy link
Contributor

@bahmutov bahmutov commented May 14, 2020

User changes

There should be no TypeScript clashes between Cypress and Jest after install

Additional details

  • adds a CircleCI test job where we install Cypress and Jest and run tsc
  • tests added
  • issue marked in ZenHub

@cypress-bot
Copy link
Contributor

cypress-bot bot commented May 14, 2020

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

@cypress
Copy link

cypress bot commented May 14, 2020



Test summary

7392 0 104 0


Run details

Project cypress
Status Passed
Commit 6a3be65
Started May 15, 2020 3:50 PM
Ended May 15, 2020 3:57 PM
Duration 06:28 💡
OS Linux Debian - 10.1
Browser Multiple

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@bahmutov
Copy link
Contributor Author

@sainthkh I have created a test job to install the built Cypress (merged from your PR) and Jest and check types, and still globals clash, which I am not sure we can resolve to be honest, since both Jest and Mocha want globals

@sainthkh
Copy link
Contributor

sainthkh commented May 15, 2020

The cause of the CI failure is the folder structure.

root/cypress
- node_modules
  - @types/mocha
- test-cypress-and-jest
  - node_modules
    - @types/jest

By default, typescript tries to load all node_modules/@types from the project and its parent folders. And in CI, we used root/cypress to build cypress and we downloaded @types/mocha in the folder. That's why this happened.

The solution to make it pass is to reorganize the folder structure.

I tried to fix it on #7359, but for some reason, test-cypress-and-jest is not executed in my PR. So, I closed it and left a review.

bahmutov and others added 3 commits May 15, 2020 08:18
@bahmutov bahmutov requested review from kuceb and flotwig May 15, 2020 13:07
Copy link
Contributor

@flotwig flotwig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, also want to see @sainthkh's thoughts since he has been working in this area a lot nvm, see he already reviewed 👍

@bahmutov bahmutov requested a review from flotwig May 15, 2020 15:46
Copy link
Contributor

@flotwig flotwig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

@bahmutov bahmutov changed the title add job testing ts types against Jest include CLI TS types in a way to avoid clashing with Jest May 15, 2020
@bahmutov bahmutov merged commit a2c0bc3 into develop May 15, 2020
@flotwig
Copy link
Contributor

flotwig commented May 18, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mocha type definitions conflict with @types/jest
3 participants