microsoft / microsoft/TypeScript

Consider allowing packages to define multiple canonical names for their modules

Abierto
#42,764 5 comentarios 12 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

In Discussion Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

Suggestion

This is based on a change in the NodeJS definitions: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/51107. For Node's ESM support, you can import NodeJS core packages (i.e., fs, path, etc.) using a fully-qualified URN with the node: prefix. The approach taken in https://github.com/DefinitelyTyped/DefinitelyTyped/pull/51107 is to re-export a module like fs using another ambient module:

declare module "node:fs" {
  export * from "fs";
}
declare module "fs" {
 ...
}

However, this belies the actual behavior of the import. "node:fs" is not a different module that happens to re-export "fs", it is actually the same module, and ideally would be handled in a way similar to how we currently handle symbolic links. With the above definitions, any module augmentations must always be made against the non-prefixed form of the module. Augmentations of the prefixed-form would be missing when importing the non-prefixed form.

We already have some mechanisms for handling this in your own project (i.e., via "paths", etc.), but not when importing from an external package (such as is the case with "fs", "path", etc.).

Should we consider adding a mechanism, be it either via syntax or via configuration (stored in package.json)?

Syntax

We can bikeshed on syntax, but I've presented a few options below:

// 1) variation of `export as namespace ...`
declare module "fs" {
  export as module "node:fs"; // essentially a symbolic link from `"node:fs"` to `"fs"`
}

// 2) declare a module with multiple names
declare module "fs", "node:fs" {
}
Configuration

If we consider approaching this problem from a configuration standpoint there are a number of directions we could take. I can update this section as we discuss this issue.

🔍 Search Terms

NodeJS, ESM, prefix, symlink

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

No se nombran archivos, pruebas ni puntos de entrada. Empieza por seguir el proceso de resolución de módulos y el manejo de módulos ambientales de TypeScript; después, compara el comportamiento existente de las rutas y los enlaces simbólicos con los ejemplos de fs y node:fs. Se considera terminado cuando exista un mecanismo definido que permita a los paquetes externos asignar varios nombres canónicos a un módulo y conservar las ampliaciones entre esos nombres.

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

Evaluación

Stack tecnológico
node.js, typescript
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.