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 (6,726 forks)batch import
DocsHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

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

Research direction
Examine the TypeScript handbook and tsconfig documentation to determine what path in project references is relative to (current tsconfig, working directory, rootDir, etc.) and propose a clarifying update.
Tech stack
typescript
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90