Microsoft/TypeScript

Public APIs not normalizing paths

Open

#9486 aperta il 2 lug 2016

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (6726 fork)batch import
BugDomain: APIHelp Wanted

Metriche repository

Star
 (48.455 star)
Metriche merge PR
 (Merge medio 6g 17h) (9 PR mergiate in 30 g)

Descrizione

As discussed in this issue, the parseJsonConfigFileContent public API can fail on Windows when passed non-normalized paths (that is, paths containing backslash delimiters).

It appears that this is not the only public API with which this occurs. The following two public API functions call getDirectoryPath with non-normalized paths:

The first of these has caused numerous issue with tsify:

Is there any guidance regarding how module authors are supposed to use public TypeScript APIs that accept paths? Are paths always expected to be normalized? If so, that puts a burden on module developers. Would it not be preferable for the parseJsonConfigFileContent, findConfigFile, resolveTripleslashReference functions to normalize any paths before calling functions - like getDirectoryPath - that expect/assume normalized paths?

Guida contributor

Direzione di ricerca
Indaga le funzioni findConfigFile e resolveTripleslashReference in src/compiler/program.ts, che chiamano getDirectoryPath con percorsi non normalizzati. Fai riferimento alla discussione nell'issue #9123 per il contesto. La correzione proposta è normalizzare i percorsi prima di passarli a getDirectoryPath. Assicurati che parseJsonConfigFileContent e altre API pubbliche gestiscano anche la normalizzazione dei percorsi in modo coerente. Considera di testare su Windows per confermare la correzione.
Tech stack
typescript
Dominio
api
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptNode.js
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45