microsoft / microsoft/TypeScript

Provide an editor-level warning when including output files

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

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

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

説明

Something that we noticed with internal codebases, as well as even with RxJS is that tsconfig.jsons are incorrectly configured for editor scenarios and include folders like dist and lib. This means you end up with slower performance, and noisy auto-imports.

We already provide some sort of error here when compiling, but we don't provide the same error in editor scenarios.

Open questions:

  • How is this information presented to the user? How is the editor given notice that it should alert a user about this?
  • What exactly does it mean to include an output file? In the case of RxJS, there are no "output files" getting included in the compilation based on how we determine a file is an an output of input files. Specifically, the root-level tsconfig.json doesn't specify an outDir, so it doesn't know that it should avoid including dist. Maybe we can use some directory-naming heuristics when we find one folder named src and another named dist or lib?

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

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

はじめの一歩

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

調査の方向性

出力ファイルを含むプロジェクトに対する既存のコンパイラーエラーから始め、同じ tsconfig.json がエディターのシナリオでどのように扱われるかを比較します。エディターにどのように通知すべきか、何を出力ファイルとみなすかを明確にし、そのうえで警告の動作と検出ルールを完了条件として定義します。

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

評価

技術スタック
typescript
領域
developer-experience, tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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