docs: update TypeScript guide to include verbatimModuleSyntax #5398
Conversation
This file contains hidden or 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
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the TypeScript guide documentation to introduce the new verbatimModuleSyntax option, which is recommended for TypeScript ≥5.0.0 and supersedes the former isolatedModules option.
- Updates links and descriptions to reference verbatimModuleSyntax
- Adds a code snippet example for using verbatimModuleSyntax in tsconfig.json
- Adjusts both Chinese and English guides to reflect this change
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/guide/basic/typescript.mdx | Updated wording to recommend verbatimModuleSyntax and add code examples |
| website/docs/en/guide/basic/typescript.mdx | Updated wording to recommend verbatimModuleSyntax and add code examples |
Comments suppressed due to low confidence (2)
website/docs/zh/guide/basic/typescript.mdx:13
- Clarify that verbatimModuleSyntax is available only in TypeScript 5.0.0 and later. Consider adding a concise note that for earlier versions, isolatedModules must be used instead.
+- 如果 `typescript` >= 5.0.0，使用 `verbatimModuleSyntax` 选项，它会默认启用 `isolatedModules` 选项：
website/docs/en/guide/basic/typescript.mdx:13
- Consider adding a brief explanation that verbatimModuleSyntax is only supported with TypeScript 5.0.0 or later, and that users with earlier versions should continue using isolatedModules.
+- If `typescript` >= 5.0.0, use the `verbatimModuleSyntax` option, it will enable `isolatedModules` option by default:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Update TypeScript guide to include the
verbatimModuleSyntaxoption. It is recommended and will supersedeisolatedModules.Related Links
importsNotUsedAsValuesandpreserveValueImportsin favor of single flag microsoft/TypeScript#51479 (comment)Checklist