Skip to content

Improve diagnostic for JSX in script files - #65394

Open
Asil Doğan Gümüş (asilgumus) wants to merge 1 commit into
microsoft:mainfrom
asilgumus:bug/64438-jsx-nonmodule-message
Open

Asil Doğan Gümüş (asilgumus) wants to merge 1 commit into
microsoft:mainfrom
asilgumus:bug/64438-jsx-nonmodule-message

Conversation

@asilgumus

Copy link
Copy Markdown

Problem

When a .tsx file is a script file (non-module) — i.e. it contains no top-level import/export (or import.meta), and it is not forced to be a module — the checker still resolves the (compiler-injected) implicit JSX runtime import (<jsxImportSource>/jsx-runtime) that TypeScript adds to every .tsx file with an automatic/implicit JSX factory. That resolution fails, and the checker reported:

error TS2875: This JSX tag requires the module path 'solid-js/jsx-runtime' to exist, but none could be found.
Make sure you have types for the appropriate package installed.

For example, with // @jsx: react-jsx, // @jsxImportSource: solid-js, // @moduleDetection: legacy and even with the package's type declarations present, a file containing just:

const x = <div />;

reports TS2875, which claims the package or its types are missing. The real reason is that the file is a script and script files cannot import modules, so the implicit jsx-runtime import cannot be resolved at all. Adding export {} (as reported in #64438) resolves it. Fixes #64438.

Root cause

getJsxNamespaceContainerForImplicitImport in tsc/internal/checker/jsx.go resolves the implicit JSX runtime import and, on failure, always reports TS2875 — without taking the importing file's module-ness into account. Under moduleDetection: legacy (or when JSX does not force module-ness), a script file will never be able to resolve that import, so TS2875's "Make sure you have types for the appropriate package installed" advice was wrong/misleading.

Fix

When the implicit JSX runtime import cannot be resolved and the importing file is not a module (!ast.IsExternalOrCommonJSModule(file)), the checker now reports a new, targeted diagnostic TS2884:

This JSX tag requires the module 'solid-js/jsx-runtime', which cannot be resolved in a script file. Add an empty 'export {}' statement to make this file a module.

Behavior summary:

Scenario Before After
Script file, runtime unresolvable/missing TS2875 (misleading: "install types") TS2884 (explains the real issue and the fix)
Module file, runtime missing TS2875 TS2875 (unchanged)
Script file, runtime resolvable no error no error (unchanged — resolution still succeeds before any error is chosen)

New message source is tsc/internal/diagnosticMessages.json; diagnostics_generated.go, diagnosticMessages.generated.json, and loc_generated.go are regenerated with npx hereby generate:diagnostics.

Tests / baselines

  • New: tsc/testdata/tests/cases/compiler/jsxScriptFile.tsx — script file with jsxImportSource and no resolvable runtime → expects TS2884 + TS7026.
  • New: tsc/testdata/tests/cases/compiler/jsxImportSourceModuleMissing.tsx — module file with missing runtime → expects the unchanged TS2875 (guards the existing behavior).
  • New: tsc/testdata/tests/cases/compiler/jsxScriptFileResolvableImportSource.tsx — script file whose runtime does resolve → expects no errors (guards against over-reporting).
  • Regenerated reference baselines; the only pre-existing baselines that changed are commentsOnJSXExpressionsArePreserved(jsx=react-jsx,module=commonjs,moduledetection=legacy).errors.txt and the react-jsxdev sibling (script files under legacy module detection now report TS2884 instead of TS2875).

go test ./internal/testrunner passes locally with these baselines.

Verification

Built tsc.exe from source; before/after:

// script file, jsx: react-jsx, jsxImportSource: solid-js, moduleDetection: legacy
- error TS2875: This JSX tag requires the module path 'solid-js/jsx-runtime' to exist, but none could be found...
+ error TS2884: This JSX tag requires the module 'solid-js/jsx-runtime', which cannot be resolved in a script file. Add an empty 'export {}' statement to make this file a module.

// same file after adding 'export {}'. It is now a module:
→ TS2875 appears again, now with the accurate "package/types missing" info for module files.

// script file with a resolvable runtime:
→ still no errors.

Note: there are other open PRs for this issue; this one targets the current main (native Go compiler) and follows its diagnostic-generation flow.

🤖 Generated with Claude Code

When a non-module (script) .tsx file uses an automatic or implicit JSX
transform, TypeScript attempted to resolve the implicit jsx-runtime
import even though script files cannot import modules, and reported
TS2875 "This JSX tag requires the module path '...' to exist, but none
could be found. Make sure you have types for the appropriate package
installed." This was misleading when the package was in fact installed
and resolvable in module mode; the actual problem is that a script
file cannot import the JSX runtime at all.

The checker now reports TS2884 when the implicit JSX runtime import
cannot be resolved from a non-module file:

"This JSX tag requires the module '{0}', which cannot be resolved in a
script file. Add an empty 'export {}' statement to make this file a
module."

Module files keep the existing TS2875 message. Fixed microsoft#64438.

Co-Authored-By: Claude Code <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 8, 2026 14:24
@github-project-automation github-project-automation Bot moved this to Not started in PR Backlog Nov 8, 2026
@typescript-automation typescript-automation Bot added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label Nov 8, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown

Asil Doğan Gümüş (@asilgumus) 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.

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.

🟡 Changes recommended

The JSX diagnostic incorrectly attributes missing-runtime resolution failures to script status and recommends module conversion that does not fix the absent dependency.

1 open issue
1 file not reviewed
  • tsc/internal/diagnostics/diagnostics_generated.go: Generated file
What changed in this PR

This PR aims to improve the native TypeScript compiler’s diagnostic for unresolved JSX runtime imports in script files, addressing #64438 with guidance to add export {}.

Changes:

  • Selects the new TS2884 diagnostic for script files while retaining TS2875 for modules.
  • Adds the diagnostic definition and generated message entries.
  • Adds three compiler tests and baselines covering missing and resolvable runtimes, and updates two existing diagnostic baselines.
File Description
tsc/​testdata/​tests/​cases/​compiler/​jsxScriptFileResolvableImportSource.tsx Tests a script with available runtime declarations.
tsc/​testdata/​tests/​cases/​compiler/​jsxScriptFile.tsx Tests a script with a missing runtime.
tsc/​testdata/​tests/​cases/​compiler/​jsxImportSourceModuleMissing.tsx Tests a module with a missing runtime.
tsc/​testdata/​baselines/​reference/​compiler/​jsxScriptFileResolvableImportSource.types Records resolvable-script types.
tsc/​testdata/​baselines/​reference/​compiler/​jsxScriptFileResolvableImportSource.symbols Records resolved JSX symbols.
tsc/​testdata/​baselines/​reference/​compiler/​jsxScriptFileResolvableImportSource.js Records resolvable-script emit.
tsc/​testdata/​baselines/​reference/​compiler/​jsxScriptFile.types Records missing-runtime script types.
tsc/​testdata/​baselines/​reference/​compiler/​jsxScriptFile.symbols Records missing-runtime script symbols.
tsc/​testdata/​baselines/​reference/​compiler/​jsxScriptFile.js Records missing-runtime script emit.
tsc/​testdata/​baselines/​reference/​compiler/​jsxScriptFile.errors.txt Expects TS2884 and TS7026.
tsc/​testdata/​baselines/​reference/​compiler/​jsxImportSourceModuleMissing.types Records missing-runtime module types.
tsc/​testdata/​baselines/​reference/​compiler/​jsxImportSourceModuleMissing.symbols Records missing-runtime module symbols.
tsc/​testdata/​baselines/​reference/​compiler/​jsxImportSourceModuleMissing.js Records module emit and runtime import.
tsc/​testdata/​baselines/​reference/​compiler/​jsxImportSourceModuleMissing.errors.txt Preserves TS2875 and TS7026 expectations.
tsc/​testdata/​baselines/​reference/​compiler/​commentsOnJSXExpressionsArePreserved(jsx=react-jsxdev,module=commonjs,moduledetection=legacy).errors.txt Updates development-runtime errors to TS2884.
tsc/​testdata/​baselines/​reference/​compiler/​commentsOnJSXExpressionsArePreserved(jsx=react-jsx,module=commonjs,moduledetection=legacy).errors.txt Updates automatic-runtime errors to TS2884.
tsc/​internal/​diagnostics/​diagnostics_generated.go Registers the generated TS2884 message.
tsc/​internal/​diagnostics/​diagnosticMessages.json Defines TS2884 and its guidance.
tsc/​internal/​diagnostics/​diagnosticMessages.generated.json Adds the generated message entry.
tsc/​internal/​checker/​jsx.go Selects the diagnostic based on module status.

Review effort: Balanced

Comment on lines +1480 to +1481
if !ast.IsExternalOrCommonJSModule(file) {
errorMessage = diagnostics.This_JSX_tag_requires_the_module_0_which_cannot_be_resolved_in_a_script_file_Add_an_empty_export_statement_to_make_this_file_a_module
@jakebailey

Copy link
Copy Markdown
Member

Why did you choose to fix this specific issue?

This branch has not been deployed

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

Labels

For Uncommitted Bug PR for untriaged, rejected, closed or missing bug

Projects

Status: Not started

Development

Successfully merging this pull request may close these issues.

Incorrect/unhelpful error message for non-module jsx file

3 participants