microsoft / microsoft/TypeScript

Can references path support package name?

オープン
#44,034 コメント 5 件 リアクション 3 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

Suggestion

🔍 Search Terms

projectReference, reference path, package name

✅ Viability 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, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

add package name path support in tsconfig references path

📃 Motivating Example

originally, when we use project in a complex repo, path config can be nasty that only relative path is supported. so we have config like blow in our tsconfig.json.

{
"references": [
    { "path": "../libs/pkg-a" },
    { "path": "../../../libraries/pkg-b" },
    { "path": "../../../libraries/pkg-c/tsconfig.es.json" }
  ]
}

This is hard to trace the referenced config path, and also leads extra job when moving this package around in the repo.
After implementation of package name support, above config can be simplified to

{
"references": [
    { "path": "@some/pkg-a" },
    { "path": "@some-other/pkg-b" },
    { "path": "@some-other/pkg-c/tsconfig.es.json" }
  ]
}

💻 Use Cases

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、tsconfig.json のプロジェクト参照設定と、現在の相対 path 値が参照先の設定をどのように識別しているかを確認します。tsconfig.es.json のようなパッケージのサブパスを含め、パッケージ名をどのように解決するかを定義します。サンプルの参照が相対パスなしで機能し、既存の参照動作が引き続きサポートされれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
build-system
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。