microsoft / microsoft/TypeScript

Can references path support package name?

Ouverte
#44,034 5 commentaires 3 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

Suggestion

🔍 Search Terms

projectReference, reference path, package name

✅ 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

add package name path support in tsconfig references path

📃 Motivating Example

originally, when we use project in a complex repo, path config can be nasty that only relative path is supported. so we have config like blow in our tsconfig.json.

{
"references": [
    { "path": "../libs/pkg-a" },
    { "path": "../../../libraries/pkg-b" },
    { "path": "../../../libraries/pkg-c/tsconfig.es.json" }
  ]
}

This is hard to trace the referenced config path, and also leads extra job when moving this package around in the repo.
After implementation of package name support, above config can be simplified to

{
"references": [
    { "path": "@some/pkg-a" },
    { "path": "@some-other/pkg-b" },
    { "path": "@some-other/pkg-c/tsconfig.es.json" }
  ]
}

💻 Use Cases

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 la configuration des références de projet dans tsconfig.json et la manière dont les valeurs relatives actuelles de path identifient les configurations référencées. Définissez comment les noms de packages, y compris les sous-chemins de package tels que tsconfig.es.json, doivent être résolus ; le travail est considéré comme terminé lorsque les références d’exemple fonctionnent sans chemins relatifs et que le comportement existant des références reste pris en charge.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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