microsoft / microsoft/TypeScript

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

Abierto
#59,879 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

🔍 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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Reproduce el problema con el tsconfig.json mostrado y la estructura de Foo.tsx, subfolder/Bar.tsx y myCustomJSX/jsx-dev-runtime.ts. Comienza por la emisión de importaciones JSX y el comportamiento de resolución de módulos de tsc; después verifica que las importaciones generadas incluyan la extensión .js y las rutas relativas correctas para ambos archivos de salida.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, typescript
Área
build-system, compilers
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.