Microsoft/TypeScript

Public APIs not normalizing paths

Aberta

#9.486 aberto em 2 de jul. de 2016

Ver no GitHubGuia do colaborador
 (4 comentários) (0 reação) (0 responsável)TypeScript (13.395 forks)batch import
BugDomain: APIHelp Wanted

Métricas do repositório

Stars
 (108.860 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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?

Guia do colaborador

Direção de pesquisa
Investigue as funções findConfigFile e resolveTripleslashReference em src/compiler/program.ts, que chamam getDirectoryPath com caminhos não normalizados. Consulte a discussão na issue #9123 para contexto. A correção proposta é normalizar os caminhos antes de passá los para getDirectoryPath. Certifique se de que parseJsonConfigFileContent e outras APIs públicas também lidem com a normalização de caminhos de forma consistente. Considere testar no Windows para confirmar a correção.
Pilha de tecnologia
typescript
Domain
api
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScriptNode.js
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
45