Repository navigation
docs(compiler): Add JSDoc for syntax and source contracts [skip chg] - #12244
Merged
Timothee Guerin (timotheeguerin) merged 11 commits intoOct 16, 2026
Conversation
microsoft-github-policy-service
Bot
added
the
compiler:core
commit: |
29 of 30 tasks
|
You can try these changes here
|
Timothee Guerin (timotheeguerin)
marked this pull request as ready for review
October 16, 2026 13:44
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:44
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes clarify existing AST contracts without changing behavior, and no unresolved issues remain.
0 open findings
What changed in this PR
Adds JSDoc to compiler syntax kinds so AST consumers can understand their syntax and roles without reading the parser.
Changes:
- Documents each
SyntaxKindmember. - Clarifies related constructs, including types versus values and declarations versus expressions.
- Preserves enum values, API signatures, and compiler behavior.
| File | Description |
|---|---|
| packages/compiler/src/core/types.ts | Adds explanatory JSDoc to SyntaxKind and its members. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Timothee Guerin (timotheeguerin)
changed the title
This was referenced Oct 16, 2026
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
308b332
into
microsoft:main
31 of 33 checks passed
Timothee Guerin (timotheeguerin)
deleted the
docs/jsdoc-compiler-syntax-kinds
branch
October 16, 2026 16:16
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
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.
AST consumers need a coherent reference for syntax kinds, source locations, symbols, declarations, and expressions rather than isolated undocumented node fields.
Document the public syntax and source contracts together, including parser limitations, node relationships, optional locations, and documentation-comment structure. No parser behavior or API signatures change.
Consolidates 12251, 12247, 12259, 12270, 12276, 12279.
Tracked in #12228.