microsoft / microsoft/TypeScript

Resolve project references from root

Open
#32,161 1 comment 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

Project reference root resolve.

Suggestion

Resolve project reference paths from root directory of a mono repository.

Use Cases

We have a large mono-repository with 1000s of sub-packages we want to convert to TS projects. Currently the references between them must be defined as relative paths, leading to configuration like:

  "references": [
    {
      "path": "../../../base"
    },
    {
      "path": "../colors"
    },
    {
      "path": "../device_capabilities"
    }
  ],

Which is:

  • Hard to read and reason about
  • Creates noisy diffs when moving packages

Ideally project references could be resolved from the root of the mono-repo project, e.g. rootDir or baseUrl options.

E.g.:

  "references": [
    {
      "path": "base"
    },
    {
      "path": "ui/base/colors"
    },
    {
      "path": "ui/base/device_capabilities"
    }
  ],

Checklist

My suggestion meets these guidelines:

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files, tests, or entry points are named in the issue. Start by locating project-reference path resolution and reviewing how rootDir and baseUrl relate to the proposed behavior; done means agreeing on and implementing root-relative references while preserving existing relative-path behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.