Skip to content

docs(compiler): Add JSDoc for diagnostics and compiler helpers [skip chg] - #12280

Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
microsoft:mainfrom
timotheeguerin:docs/jsdoc-compiler-helpers
Closed

Timothee Guerin (timotheeguerin) wants to merge 2 commits into
microsoft:mainfrom
timotheeguerin:docs/jsdoc-compiler-helpers

Conversation

@timotheeguerin

@timotheeguerin Timothee Guerin (timotheeguerin) commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

Compiler integrations need to know whether helpers merely resolve edits or write files, how source locations and parser traversal behave, and which state is local to a program. Add JSDoc for these existing contracts, including emitted line endings, path normalization, typed diagnostic messages, and collection and timing helpers.

This improves the public reference without changing signatures, exports, or behavior.

Tracked in #12228.

@microsoft-github-policy-service microsoft-github-policy-service Bot added the compiler:core Issues for @typespec/compiler label Oct 15, 2026
@pkg-pr-new

pkg-pr-new Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/compiler@12280

commit: c4c6ae9

@azure-sdk-automation

Copy link
Copy Markdown

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Note

This error may be related to your runner configuration. You can now configure runners for Copilot code review separately from Copilot cloud agent by creating a copilot-code-review.yml file with your setup steps. Read the docs for details.

@timotheeguerin

Copy link
Copy Markdown
Member Author

Consolidated into #12249 to keep one PR per package and at most five compiler PRs. The reviewed changes and corrections are preserved there.

Tracked in #12228.

Timothee Guerin (timotheeguerin) added a commit that referenced this pull request Oct 16, 2026
…p chg] (#12249)

Compiler integrations should not need to inspect loaders, emitters, and
diagnostic internals to understand configuration, compilation, host
capabilities, and helper failure modes.

Document these public contracts together: configuration and resolution,
programs and utilities, diagnostics and code fixes, emission and
logging. Clarify defaults, error propagation, numeric limits, and
supplied versus resolved options without changing behavior.

Consolidates [12260](#12260),
[12263](#12263),
[12278](#12278),
[12280](#12280).

Tracked in #12228.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

compiler:core Issues for @typespec/compiler

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants