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

Fixed dependency issues between JSDOM and betterdocs #189

Merged
merged 14 commits into from
Jul 14, 2020
Merged

Conversation

devYaoYH
Copy link
Collaborator

@devYaoYH devYaoYH commented Jul 14, 2020

Background:
[same issue we are facing] jsdom/jsdom#2961
[identified cause] https://github.com/microsoft/TypeScript/blob/27616dd523279a5d699d2154edb4de6abc8234ad/src/services/globalThisShim.ts#L21

Upgraded typescript doesn't play well with node10 and JSDOM which jest uses to mock browser

Solution: Freeze typescript version to 3.7.5 that works with both JSDOM and is the minimum version required for betterdocs
Conclusion: In some version of typescript 3.8.x + added a globalThis redefinition? that breaks JSDOM dependency in jest-environment-jsdom-sixteen we are using for testing (original out-of-the-box typescript dependency for CRA was set to ~3.7.2 which in yarn syntax means we look for minimum >= 3.7.2 but allow upgrades up to the major version so < 4.0.0)

@devYaoYH devYaoYH changed the title Bumped up typescript version in hopes globalThis issue is fixed in newer version Fixed dependency issues between JSDOM and betterdocs Jul 14, 2020
@devYaoYH devYaoYH merged commit afb7728 into master Jul 14, 2020
@devYaoYH devYaoYH deleted the better-testing branch July 14, 2020 11:43
@devYaoYH devYaoYH linked an issue Jul 14, 2020 that may be closed by this pull request
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.

Configure JSDoc for javascript documentation
2 participants