microsoft / microsoft/TypeScript

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

Ouverte
#35,292 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner comment les champs types et typings de package.json sont actuellement interprétés, ainsi que la section Common Feature Requests de la FAQ. Définissez l’alias spécifique à TypeScript proposé et sa compatibilité avec les métadonnées de package existantes ; le travail sera considéré comme terminé lorsqu’un design convenu et une implémentation validée par rapport au comportement de package-resolution seront disponibles.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.