microsoft / microsoft/TypeScript

Allow `.js` file generated from `.tsx` file to be runnable in browser with less configuration

Open
#59,879 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔍 Search Terms
  • jsx-dev-runtime.js
  • jsx-runtime.js
✅ Viability Checklist
⭐ Suggestion

The .js file generated from .tsx file should have file extension in the injected import statement.
Also, if the value of jsxImportSource is relative (for e.g. ./myCustomJSX instead of myCustomJSX), the import statement should have correct relative path to JSX runtime files.

📃 Motivating Example

Suppose, a web project has following files and folders:

  • /tsconfig.json
  • /myCustomJSX/jsx-dev-runtime.ts
  • /Foo.tsx
  • /subfolder/Bar.tsx
  • /index.html

And, tsconfig.json looks like:

{
  "compilerOptions": {
    "jsx": "react-jsxdev",
    "jsxImportSource": "./myCustomJSX",
  }
}

After running npx tsc, all generated .js files (/Foo.js, /subfolder/Bar.js) have following code at the top:

import { jsxDEV as _jsxDEV, Fragment as _Fragment } from "./myCustomJSX/jsx-dev-runtime";

There are three problems with this:

  1. The .js extension is missing in the import statement.
  2. The path of the module is not accurate for /subfolder/Bar.js
  3. Also, tsc shows following error for /subfolder/Bar.tsx:
    subfolder/Bar.tsx:13:3 - error TS2307: Cannot find module './myCustomJSX/jsx-dev-runtime' or its corresponding type declarations.
    

Expected behavior:

/Foo.js:

import { jsxDEV as _jsxDEV, Fragment as _Fragment } from "./myCustomJSX/jsx-dev-runtime.js";

/subfolder/Bar.js:

import { jsxDEV as _jsxDEV, Fragment as _Fragment } from "../myCustomJSX/jsx-dev-runtime.js";
💻 Use Cases
  1. What do you want to use this for?
    I want to use this for web project that utilizes JSX syntax and uses only TypeScript as build tool.

  2. What shortcomings exist with current approaches?
    The current approach requires too much extra steps when using the generated .js file in web project without additional build steps, especially when using relative path in jsxImportSource.

  3. What workarounds are you using in the meantime?
    I am providing following in importmap in /index.html file:

    <script type="importmap">
    {
      "imports": {
        "./myCustomJSX/jsx-dev-runtime": "./myCustomJSX/jsx-dev-runtime.js"
        "./subfolder/myCustomJSX/jsx-dev-runtime": "./myCustomJSX/jsx-dev-runtime.js"
      }
    }
    </script>
    

    However, the importmap can grow when there are .tsx files in many depths in file system.
    If this issue is solved, there won't be any need for importmap when using relative path in jsxImportSource. However, for bare module path, 1 entry in importmap is still required.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with the shown tsconfig.json and the Foo.tsx, subfolder/Bar.tsx, and myCustomJSX/jsx-dev-runtime.ts layout. Start with tsc's JSX import emission and module-resolution behavior, then verify that generated imports include the .js extension and correct relative paths for both output files.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
build-system, compilers
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.