microsoft / microsoft/TypeScript

Suggest imports to self-reference a package by its name when it has an `exports` field

Abierto
#54,080 1 comentario 21 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

Suggestion

🔍 Search Terms

Package self reference auto import

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Node.js supports self-referencing a package using its name when it has an exports field. Note this is distinct from self-referencing a package working in some monorepo setups where there are symlinks from node_modules to the packages. This doesn't rely on any symlinks, it looks up to the nearest package.json and if it has a name and exports field, importing that package name resolves there. This works correctly with moduleResolution nodenext/bundler but TypeScript doesn't suggest auto-imports to the package name or have completions to the package name in import specifiers, it would be nice if it did.

This is essentially the same request as #52460 but about a package's own exports rather than its imports.

This is also sort of a request for the opposite behaviour than requested in #26044 except that this is specifically only about packages that have an exports field where TypeScript is configured to use the exports field. I don't think this really conflicts with that issue since the problem there is that without exports, it can lead to imports like my-pkg/src/something which you don't want but since package self-referencing like this requires an exports field, imports like that wouldn't be allowed.

📃 Motivating Example

Let's say you have a package that looks like this:

// package.json
{
  "name": "my-package",
  "type": "module",
  "exports": "./index.js"
}
// index.js
export function doSomething() {}
// index.d.ts
export declare function doSomething(): void;

And you'd like to write tests that reference the package name so it's easy to see that the tests only use the package's public API specified in exports, you can already do this and it will correctly compile with moduleResolution bundler/nodenext but with this feature, the suggested import would be to my-package rather than ./index.js.

// index.test.ts
import { doSomething } from 'my-package';

// some tests...

💻 Use Cases

As mentioned above, being able to easily write tests that only use a package's public API in the same way that users would use it via the package name without having to work around auto-import by changing the import after auto-import suggests a relative path.

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 ejemplo usando package.json con un campo name y un campo exports, index.d.ts e index.test.ts bajo moduleResolution nodenext o bundler. Empieza rastreando el manejo de nombres de paquetes en auto-import y en las finalizaciones de import-specifier; se considera terminado cuando TypeScript sugiere el nombre del paquete para la exportación pública sin romper las sugerencias existentes de rutas relativas.

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

Evaluación

Stack tecnológico
node.js, typescript
Área
developer-experience, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.