microsoft / microsoft/TypeScript

Provide a clear and explicit TypeScript pkg.types alternative, such as pkg.typescriptTypes

Offen
#35,292 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Search Terms

package.types, package.json types, types, typings, ts-types

Suggestion

It would be great if TS provided an additional alias for package.json's types/typings fields.

This new alias should make it clear it refers to TypeScript types, so that projects that provide more than one type system can avoid ambiguity.

A possible solution would be a new ts-types field.

Use Cases

See "Suggestion"

Examples

{
  "name": "my-library",
  "ts-types": "ts-types/index.d.ts"
}

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, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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

Beginne damit, zu prüfen, wie die Felder types und typings von package.json derzeit interpretiert werden, zusammen mit dem Abschnitt Common Feature Requests der FAQ. Definiere den vorgeschlagenen TypeScript-spezifischen Alias und seine Kompatibilität mit bestehenden Paketmetadaten; als abgeschlossen gilt die Aufgabe, wenn ein abgestimmtes Design und eine Implementierung vorliegen, die anhand des package-resolution-Verhaltens validiert wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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