microsoft / microsoft/TypeScript

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

Offen
#54,080 1 Kommentar 21 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Domain: LS: Auto-import Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere das Beispiel mit package.json mit einem name- und exports-Feld, index.d.ts und index.test.ts unter moduleResolution nodenext oder bundler. Beginne damit, die Handhabung von Paketnamen bei auto-import und Import-Spezifizierer-Vervollständigungen nachzuverfolgen; abgeschlossen ist die Aufgabe, wenn TypeScript den Paketnamen für den öffentlichen Export vorschlägt, ohne bestehende Vorschläge für relative Pfade zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
node.js, typescript
Bereich
developer-experience, tooling
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.