Microsoft/TypeScript

Public APIs not normalizing paths

Open

#9,486 opened on 2016年7月2日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
BugDomain: APIHelp Wanted

説明

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?

コントリビューターガイド

技術スタック
typescript
領域
tooling
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
4
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
over 1 week
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
needs maintainer response
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
TypeScript compiler internalscross platform path handling
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
20
調査方針
Investigate the functions findConfigFile and resolveTripleslashReference in src/compiler/program.ts, which call getDirectoryPath with non normalized paths. Refer to the discussion in issue #9123 for context. The proposed fix is to normalize paths before passing them to getDirectoryPath. Ensure that parseJsonConfigFileContent and other public APIs also handle path normalization consistently. Consider testing on Windows to confirm the fix.