Repository navigation
docs(emitter-framework): Add JSDoc for testing helpers [skip chg] - #12227
Closed
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Closed
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Conversation
microsoft-github-policy-service
Bot
added
the
emitter-framework
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:45
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:45
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
Documents emitter-framework testing helpers as part of the public API JSDoc improvements, without changing runtime behavior or API signatures.
Changes:
- Clarifies snippet matching, unsupported queries, and built-in language configurations.
- Documents scenario compilation, formatting, comparison, and expectation recording.
| File | Description |
|---|---|
| packages/emitter-framework/src/testing/scenario-test/snippet-extractor.ts | Documents extraction contracts and language configurations. |
| packages/emitter-framework/src/testing/scenario-test/harness.ts | Documents scenario registration, execution, and recording. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
Timothee Guerin (timotheeguerin)
added a commit
that referenced
this pull request
Oct 16, 2026
Emitter authors need usable contracts across contexts, language components, transformations, and testing helpers, not just component names and TypeScript signatures. Document the public emitter framework together, including its C#, TypeScript, and Python components. Explain defaults, supported input shapes, transformation scope, and error filtering without changing generated output or APIs. Consolidates [12213](#12213), [12220](#12220), [12223](#12223), [12226](#12226), [12227](#12227). Tracked in #12228.
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.
Emitter tests need predictable snippet selection and clear ownership of grammar mappings, formatting, and scenario recording.
Document exact-name extraction and unsupported-query behavior, each built-in language configuration, and how the Vitest scenario harness compiles, compares, or rewrites Markdown expectations. Clarify that extraction preserves source text while formatting belongs to the harness. Documentation only.
Tracked in #12228.