microsoft / microsoft/TypeScript

Can references path support package name?

Aperta
#44,034 5 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando la configurazione dei riferimenti al progetto in tsconfig.json e il modo in cui gli attuali valori relativi di path identificano le configurazioni referenziate. Definisci come devono essere risolti i nomi dei package, inclusi i sottopercorsi dei package come tsconfig.es.json; il lavoro è completato quando i riferimenti di esempio funzionano senza percorsi relativi e il comportamento esistente dei riferimenti continua a essere supportato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
build-system
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.