docs(start): clarify verbatimModuleSyntax must be disabled#7806
Open
galaxykhh wants to merge 1 commit into
Open
docs(start): clarify verbatimModuleSyntax must be disabled#7806galaxykhh wants to merge 1 commit into
galaxykhh wants to merge 1 commit into
Conversation
The build-from-scratch guides only said to keep `verbatimModuleSyntax` disabled without showing how, and didn't mention that `tsc --init` (TypeScript 5.9+ and 6.0) now generates `"verbatimModuleSyntax": true`. Add `"verbatimModuleSyntax": false` to the example tsconfig and clarify that the compiler default is still `false` while the init template opts in. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughTanStack Start documentation and counter examples now explicitly configure ChangesverbatimModuleSyntax configuration
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
|
||
| > [!NOTE] | ||
| > Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled. | ||
| > TanStack Start does not support `verbatimModuleSyntax` enabled — it can cause server-only code to leak into client bundles. |
Collaborator
There was a problem hiding this comment.
it's not that we dont "support" it. it can be used but could cause those leaks if types are imported from modules that have server only code
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
"verbatimModuleSyntax": falsein the exampletsconfig.jsonfalse, whiletsc --init(TypeScript 5.9+ and 6.0) generates"verbatimModuleSyntax": trueas a recommended optionstart-counterexamples (linked from the React guide) and the Start core skill doc with the same guidanceProblem
The build-from-scratch guides warn that enabling
verbatimModuleSyntaxcan cause server-only code to leak into client bundles, but they:tsconfig.jsontsc --initnow generates"verbatimModuleSyntax": true(tsc --init update microsoft/TypeScript#61813)This is especially relevant for TypeScript 6 users who run
tsc --initbefore following the guide, since the generated config opts intoverbatimModuleSyntaxeven though the compiler default remainsfalse.Changes
docs/start/framework/react/build-from-scratch.md"verbatimModuleSyntax": falseto example tsconfig; expand NOTEdocs/start/framework/solid/build-from-scratch.mdexamples/react/start-counter/tsconfig.json"verbatimModuleSyntax": falseexamples/solid/start-counter/tsconfig.jsonpackages/start-client-core/skills/start-core/SKILL.mdtsc --initbehaviorTest plan
tsconfig.jsonfiles remain valid JSONSummary by CodeRabbit
Documentation
verbatimModuleSyntaxtofalse, particularly when usingtsc --initwith newer TypeScript versions.Configuration