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

Add recommendation for tsconfig.json with TypeScript 5+ #1638

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

berniegp
Copy link

@berniegp berniegp commented Nov 24, 2023

Rollup Plugin Name: @rollup/plugin-typescript

This PR contains:

  • bugfix
  • feature
  • refactor
  • documentation
  • other

Are tests included?

  • yes (bugfixes and features will not be merged without tests)
  • no

Breaking Changes?

  • yes (breaking changes will not be merged unless absolutely necessary)
  • no

If yes, then include "BREAKING CHANGES:" in the first commit message body, followed by a description of what is breaking.

List any relevant issue numbers:

Description

  • Added recommendations for tsconfig.json and TypeScript 5.0 based on the TypeScript docs and my experience here: berniegp/mock-xmlhttprequest@ce29b1b)
  • Expanded the "Why?" presentation section
  • Fixed a few typos in "TypeScript"

As far as I can see, the new bundler option is perfect for use with Rollup, but it would be great for someone else to have a look. It took me a long time to figure out the correct options to use with Node 16 and TS 5+ so I hope that this recommendation will help others.

Also I'm not sure if there should be extra tests to test this configuration.

@shellscape
Copy link
Collaborator

Thanks for the PR. While I think this is good info, it doesn't look suited to the readme for the typescript plugin. If you're up for it, I would suggest creating a packages/typescript/recipes/file-extensions.md file that contained a more verbose description of the setup.

@berniegp
Copy link
Author

I can have a look at that time permitting. You're referring to the "tsconfig.json recommendations" section to move to another page right?

Should I modify my branch to remove that part so the other changes can be merged?

@shellscape
Copy link
Collaborator

Yes that's correct. Since the bulk of the other changes are a change of Typescript -> TypeScript, I'd recommend just making all changes before we merge anything.

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.

None yet

2 participants