Repository navigation
docs(tmlanguage-generator): Add JSDoc for grammar generation APIs [skip chg] - #12254
Merged
Timothee Guerin (timotheeguerin) merged 1 commit intoOct 16, 2026
Conversation
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 match the implementation, with no unresolved findings.
0 open findings
What changed in this PR
Adds public API JSDoc to the TextMate grammar generator as part of #12228, without changing signatures or runtime behavior.
Changes:
- Documents rule identity, shared/cyclic references, captures, scopes, and regex syntax.
- Clarifies emitter output, ordering, input ownership, and validation diagnostics.
| File | Description |
|---|---|
| packages/tmlanguage-generator/src/tmlanguage-generator.ts | Adds JSDoc for grammar types, members, and emitters. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
3719818
into
microsoft:main
34 checks passed
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.
Grammar authors need to know how rule objects become repository references, which regular-expression syntax is accepted, and what the emitters return. Document the exposed grammar types and their members, including shared/cyclic rules, capture mappings, meta scopes, and validation diagnostics.
Clarifies JSON/PList output ordering and input ownership without changing API signatures or behavior.
Tracked in #12228.