Skip to content

Keep JSDoc on expando hosts declared as arrows or function expressions - #4858

Open
Yogesh Kumar (yogesh968) wants to merge 1 commit into
microsoft:mainfrom
yogesh968:fix-4295-expando-arrow-jsdoc
Open

Keep JSDoc on expando hosts declared as arrows or function expressions#4858
Yogesh Kumar (yogesh968) wants to merge 1 commit into
microsoft:mainfrom
yogesh968:fix-4295-expando-arrow-jsdoc

Conversation

@yogesh968

Copy link
Copy Markdown

Fixes #4295

Analysis

An expando host can be written either as a function declaration or as a variable
whose initializer is an arrow function / function expression. Declaration emit
turns both into a declare function, but it builds them in two different ways in
transformExpandoHost:

if ast.IsFunctionDeclaration(declaration) {
    // updates the original node
    replacement = append(replacement, tx.Factory().UpdateFunctionDeclaration(declaration.AsFunctionDeclaration(), ...))
} else if ast.IsVariableDeclaration(declaration) && ast.IsFunctionExpressionOrArrowFunction(declaration.Initializer()) {
    // builds a brand new node
    replacement = append(replacement, tx.Factory().NewFunctionDeclaration(...))
}

The first branch goes through Update..., so the result keeps the original node's
position. The second branch synthesizes a node from scratch, so its Loc is
synthesized.

Printer.emitCommentsBeforeNode asks EmitContext.CommentRange(node) for the range
to scan for leading comments, and that getter falls back to node.Loc when no
explicit range was set. For the synthesized node that is a synthesized position, so
emitLeadingCommentsOfNode takes the PositionIsSynthesized path and skips leading
comments entirely — the JSDoc written above the variable statement is silently
dropped from the .d.ts.

Given this input:

/**
 * jsdoc description on `ExpandoArrowNamedExport`
 */
const ExpandoArrowNamedExport = () => { return null; };
ExpandoArrowNamedExport.args = { num: 3 };

export { ExpandoArrowNamedExport };

TypeScript 6.0.3 emits the comment, and tsgo does not:

// tsc 6.0.3                             // tsgo (before)
/**                                      declare function ExpandoArrowNamedExport(): null;
 * jsdoc description on ...              declare namespace ExpandoArrowNamedExport {
 */                                          var args: { num: number; };
export function ExpandoArrowNamedExport(): null;

Fix

Set an explicit comment range on the synthesized function declaration, pointing at
the variable statement — which is where JSDoc on the host is written, and whose
Pos() starts before the leading trivia. This mirrors what the sibling
Update... branch gets for free, and matches the existing idiom a few hundred
lines up in the same file (SetOriginal + SetCommentRange on a synthesized
declaration list).

Alternatives considered: also calling EmitContext.SetOriginal(funcDecl, root).
That copies the original's emit node and makes MostOriginal resolve the
synthesized function back to the variable statement, which is more than is needed
here — the comment range is the only thing the printer is missing — so I kept the
change to the narrower of the two.

Effect on the table in #4295

Measured against typescript@6.0.3, .js inputs:

tsc 6.0.3 tsgo before tsgo after
ExpandoFunctionInlineNamedExport comment comment comment
ExpandoArrowInlineNamedExport no comment no comment comment
ExpandoFunctionNamedExport comment comment comment
ExpandoArrowNamedExport comment no comment comment
ExpandoFunctionDefaultExport comment comment comment
ExpandoArrowDefaultExport comment no comment comment

Two rows converge onto 6.0 behavior. The second row does not: 6.0 drops the comment
when the expando arrow is exported inline, and after this change tsgo keeps it.

The .ts columns of that table are covered too: tsgo routes .ts expando hosts
through this same synthesis, so they gain the comment as well. (6.0 emits those as
declare const X: { (): null; args: ... } instead of a function/namespace pair —
a separate shape difference that this change does not touch.)

I did not try to reproduce that omission. Both branches of transformExpandoHost
describe the same construct, and the only thing separating this row from the
ExpandoArrowNamedExport row directly below it is where the export keyword sits,
which does not seem like a distinction the emitter should be preserving. Suppressing
it again would mean special-casing exported variable statements purely to reproduce
what looks like an artifact of Strada's node reuse. The issue notes this row is
expected to change ("the comment emit fix for arrows will be a breaking change from
TS 6"). Happy to gate it if you would rather hold the line at exact 6.0 parity.

Testing

New test at testdata/tests/cases/compiler/expandoArrowFunctionDeclarationEmitJSDoc.ts
covering the named-export, inline-export and default-export forms, for both arrow
functions and function expressions, with function declarations alongside them as
controls. Baselines were accepted before the fix and re-accepted after, so the diff
on the baseline file shows exactly which comments the change adds.

No other baselines in the suite changed.

Disclosure

Per CONTRIBUTING.md: this patch was authored with AI assistance (Claude Code). I
picked the issue, reviewed the diff and the baseline changes, ran the build, tests,
lint and format locally, and I will be the one responding to review feedback here.

Copilot Checklist

I successfully ran these commands at the end of my session, and they completed without error:

  • npx hereby build
  • npx hereby test
  • npx hereby lint
  • npx hereby format

Being straight about the two unticked boxes rather than claiming them — my machine ran
out of disk partway through and I could not get either to complete end to end.

What I did run green, individually:

go test ./internal/testrunner       ok  395.081s   <- all compiler baselines
go test ./internal/execute/...      ok             <- tsc/tsctests/build/watch
go test ./internal/printer/...      ok
go test ./internal/parser/...       ok  193.616s
go test ./internal/checker/...      ok
go test ./internal/transformers/... ok
gofmt -l internal/transformers/declarations/transform.go   (clean)
go vet ./internal/transformers/declarations/               (clean)

The compiler baseline run is the one that matters most for this change, and it wrote
zero files into testdata/baselines/local — every one of the ~49k reference baselines
matched, so nothing outside the new test moved.

npx hereby lint never got as far as linting: building the custom golangci-lint binary
filled the disk (compile: writing output: ... There is not enough space on the disk).
./internal/fourslash/... is the other suite I did not run. Both should be covered by
CI here — please shout if either turns up something and I will fix it.

Declaration emit turns an expando host into a `declare function` two different
ways: function declarations go through UpdateFunctionDeclaration and keep the
original node's position, while a variable whose initializer is an arrow function
or function expression is synthesized with NewFunctionDeclaration and has no
position at all.

The printer resolves a node's comment range via EmitContext.CommentRange, which
falls back to node.Loc. For the synthesized node that is a synthesized position,
so emitLeadingCommentsOfNode skips leading comments and the JSDoc written above
the variable statement never reaches the .d.ts.

Set the comment range on the synthesized declaration to the variable statement it
stands in for, which is where that JSDoc lives.
Copilot AI balanced review requested due to automatic review settings August 10, 2026 06:29

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 was unable to review this pull request because the user who requested the review has reached their quota limit.

@microsoft-github-policy-service

Copy link
Copy Markdown

Yogesh Kumar (@yogesh968) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

1 similar comment
@microsoft-github-policy-service

Copy link
Copy Markdown

Yogesh Kumar (@yogesh968) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Behavior difference: (jsdoc) comment emit inconsistencies on expando functions

3 participants