microsoft / microsoft/TypeScript
Warning or error when importing files from a project's own outDir
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
Search Terms
import, outDir, composit, TS5055
Suggestion
Add a specific warning/error when trying to import something from the projects own outDir.
Use Cases
Help track down files that are wrongly importing from it's own dist directory.
I don't know if there are valid use cases where you would want to do this but I can only think of (refactor) errors.
Examples
In a big refactor I moved a class from a project to a shared directory (compiled with composite: true, imported into projects with "references").
I made the following change without thinking because it satisfied the compiler.
- import mongoose from "../../shared/dist/mongo";
+ import mongoose from "../dist/mongo";
Everything seemed to work fine (no error was shown in vscode on the import line itself, and the now shared class worked) until the next week I notice the following errors when compiling the shared dir:
error TS5055: Cannot write file '.../shared/dist/interfaces/branch.d.ts' because it would overwrite input file.
error TS5055: Cannot write ...
I did not notice these errors while doing the refactor itself because the tsc -w for the shared directory was running in a forgotten terminal tab. A warning or error on the import line itself when doing something like this would save a lot of debugging time.
Checklist
My suggestion meets these guidelines: (this is my guess, don't know exactly what the change would entail)
- 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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue では、ソースファイル、テスト、コンパイラのエントリポイントが指定されていません。プロジェクト自身の outDir から import して composite-project のケースを再現し、その後、モジュール解決と diagnostics がその import をどのように処理するかを追跡してください。問題のある import を指し示す具体的な警告またはエラーがあり、回帰テストのカバレッジが追加されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 30/100