microsoft / microsoft/TypeScript

Add API to query if SourceFile originated from typeRoots lookup

Aperta
#26,684 3 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Domain: API In Discussion Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

This proposes to add an API Program#isSourceFileFromTypeRoots that is similar to Program#isSourceFileFromExternalLibrary but for typeRoots.

Currently the only way to determine if a SourceFile comes from typeRoots is to use ts.getEffectiveTypeRoots and check if a given SourceFile#fileName starts with any of the paths.

That works if there are no symlinks. With symlinks one needs to use realpath on all of the typeRoots before comparing to fileName as that is already a realpath.
And even that doesn't cover cases where a subdirectory (like node_modules/@types/foo) or an individual file (node_modules/@types/foo/index.d.ts) is a symlink.

Related: https://github.com/fimbullinter/wotan/issues/387

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 leggendo Program#isSourceFileFromExternalLibrary, ts.getEffectiveTypeRoots e la gestione di SourceFile#fileName. Traccia il modo in cui vengono rappresentati typeRoots e le directory o i file collegati simbolicamente, quindi aggiungi l’API proposta Program#isSourceFileFromTypeRoots con la copertura di questi casi. Il lavoro è completato quando i chiamanti non devono più confrontare autonomamente i percorsi.

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

Valutazione

Stack tecnologico
typescript
Ambito
api, compilers
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
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.