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

Set CommonJS module format when transpiling TS code #7197

Merged
merged 7 commits into from
May 4, 2020

Conversation

bahmutov
Copy link
Contributor

@bahmutov bahmutov commented May 1, 2020

User facing changelog

Default TypeScript options now set module: commonJS which Node and the browser expect. Before this PR user could set module: nextjs in their tsconfig.json and nothing would work if you had import or async keywords in the source code.

How has the user experience changed?

Previously failing projects should work.

PR Tasks

  • Have tests been added/updated?
  • Has the original issue been tagged with a release in ZenHub?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented May 1, 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 1, 2020



Test summary

3351 0 49 0


Run details

Project cypress
Status Passed
Commit 17a1e55
Started May 3, 2020 7:01 PM
Ended May 3, 2020 7:07 PM
Duration 05:21 💡
OS Linux Debian - 10.1
Browser Firefox 74

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 bahmutov requested review from sainthkh and chrisbreiding May 1, 2020 17:08
@bahmutov bahmutov marked this pull request as ready for review May 1, 2020 17:08
@tgriesser tgriesser self-requested a review May 1, 2020 21:22
tgriesser
tgriesser previously approved these changes May 1, 2020
Copy link
Member

@tgriesser tgriesser left a comment

Choose a reason for hiding this comment

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

I think we may want to allow for more options for folks to specify which tsconfig file they want to use explicitly, and/or whether transpileOnly is true. But for now I'm 👍 on this change.

Copy link
Contributor

@sainthkh sainthkh left a comment

Choose a reason for hiding this comment

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

LGTM. I found only a minor error. 👍

packages/server/lib/plugins/child/run_plugins.js Outdated Show resolved Hide resolved
Co-authored-by: Kukhyeon Heo <sainthkh@naver.com>
@brian-mann
Copy link
Member

@tgriesser can you rereview and approve? i accepted one change from @sainthkh that caused your review to be dismissed

@brian-mann brian-mann requested a review from tgriesser May 3, 2020 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants