Microsoft/TypeScript

Clarity about the what path references are relative to

Open

#50,529 opened on Aug 29, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
DocsHelp Wanted

Description

Suggestion

🔍 Search Terms

references path relative

✅ Viability Checklist

My suggestion meets these guidelines:

  • [ x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • [x ] This wouldn't change the runtime behavior of existing JavaScript code
  • [ x] This could be implemented without emitting different JS based on the types of the expressions
  • [x ] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • [x ] This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Both https://www.typescriptlang.org/tsconfig#references and https://www.typescriptlang.org/docs/handbook/project-references.html aren't specific about what the string in path is relative to (the current tsconfig, the current working directory, rootDir, etc)

💻 Use Cases

I'm writing some build scripts around invocations of tsc with a lot of linking, aliasing, etc and I don't want to put absolute paths in the generated tsconfig files

Contributor guide

Tech stack
typescript
Domain
documentationtooling
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with TypeScript project referencesbasic knowledge of tsconfig.json
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the TypeScript documentation at https://www.typescriptlang.org/tsconfig#references and the handbook page on project references to identify where path resolution is ambiguous. Clarify whether paths are relative to the tsconfig file, the current working directory, rootDir, or something else. Ensure the documentation specifies the base path explicitly.