Repository navigation
docs(compiler): Add JSDoc for rule assertions and legacy hosts [skip chg] - #12275
Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Conversation
microsoft-github-policy-service
Bot
added
the
compiler:core
29 of 30 tasks
commit: |
|
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 reviewed implementations, with no unresolved findings or behavioral changes.
0 open findings
What changed in this PR
Clarifies compiler testing API contracts as part of the public JSDoc improvements tracked in #12228, without changing signatures or runtime behavior.
Changes:
- Documents linter rule assertions, diagnostic matching, and code-fix expectations.
- Explains legacy host state, virtual files, wrapper defaults, and prefix offsets.
- Clarifies file discovery and source-trimming behavior.
| File | Description |
|---|---|
packages/compiler/src/testing/types.ts |
Documents legacy host and runner contracts. |
packages/compiler/src/testing/test-utils.ts |
Explains wrapper options and source trimming. |
packages/compiler/src/testing/test-host.ts |
Documents file discovery exclusions. |
packages/compiler/src/testing/test-compiler-host.ts |
Describes automatically mounted compiler support. |
packages/compiler/src/testing/rule-tester.ts |
Clarifies rule lifecycle and assertion requirements. |
packages/compiler/src/testing/expect.ts |
Explains ordered diagnostic matching and source offsets. |
packages/compiler/src/testing/code-fix-testing.ts |
Documents parsed-source code-fix assertions. |
🧠 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
…12243) Library authors and compiler-tooling consumers lack consistent guidance for testing, listeners, standard-library metadata, typekit operations, and experimental extensions. Document the public testing and extension APIs together, including diagnostic assertions, state ownership, listener scope, and experimental realm/mutator contracts. Preserve existing deprecation guidance and behavior. Consolidates [12252](#12252), [12269](#12269), [12271](#12271), [12273](#12273), [12275](#12275). 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.
Authors testing a linter rule need to know which diagnostics are asserted, how rule defaults are applied, and when file inputs or result callbacks require a modern tester instance. These contracts now explain the rule lifecycle, ordered diagnostic matching, and selection of code fixes.
The remaining legacy host members document virtual entrypoints, retained state, default imports, and prefix offsets without rewriting their existing deprecation/migration notices. No exports, signatures, or behavior change.
Tracked in #12228.