microsoft / microsoft/TypeScript

Resolve project references from root

Ouverte
#32,161 1 commentaire 9 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

Project reference root resolve.

Suggestion

Resolve project reference paths from root directory of a mono repository.

Use Cases

We have a large mono-repository with 1000s of sub-packages we want to convert to TS projects. Currently the references between them must be defined as relative paths, leading to configuration like:

  "references": [
    {
      "path": "../../../base"
    },
    {
      "path": "../colors"
    },
    {
      "path": "../device_capabilities"
    }
  ],

Which is:

  • Hard to read and reason about
  • Creates noisy diffs when moving packages

Ideally project references could be resolved from the root of the mono-repo project, e.g. rootDir or baseUrl options.

E.g.:

  "references": [
    {
      "path": "base"
    },
    {
      "path": "ui/base/colors"
    },
    {
      "path": "ui/base/device_capabilities"
    }
  ],

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

L’issue ne nomme aucun fichier source, test ou point d’entrée. Commencez par localiser project-reference path resolution et examiner la relation entre rootDir et baseUrl et le comportement proposé ; le travail sera considéré comme terminé lorsque des root-relative references auront été définies et implémentées tout en préservant le comportement existant pour les chemins relatifs.

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

Évaluation

Stack technique
typescript
Domaine
build-system, compilers
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.