Microsoft/TypeScript

Public APIs not normalizing paths

Open

#9,486 opened on Jul 2, 2016

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

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?

Contributor guide

Tech stack
typescript
Domain
tooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript compiler internalscross platform path handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
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.
Public APIs not normalizing paths · Microsoft/TypeScript#9486 | Good First Issue