Use absolute file paths in error messages

オープン
#36,221 コメント 20 件 リアクション 59 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
typescript
領域
cli, compilers

調査の方向性

yarn workspaces run tsc と例のパス packages/koas-core/src/index.ts を使って問題を再現します。まず、tsc が診断情報内のファイルパスをどのようにフォーマットしているかを追跡します。診断情報で絶対パスを生成できるか、絶対パスを要求するためのサポートされた方法を提供でき、設定されていない場合は既存の動作を維持できれば完了です。

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

説明

Domain: Error Messages In Discussion Suggestion

Search Terms

absolute

Suggestion

Output absolute paths in type errors for tsc, or at least a way to specify this.

Use Cases

When type checking in monorepositories, typically tsc is run for each workspace. tsc is then run relative to the workspace it is run from, whereas developers are mostly interested in either the absolute path, or the path relative to the project root.

I have configured my terminal emulator so I can CTRL-click a file and then the file is opened in VSCode, even on the correct line. This works for tsc output in simple TypeScript projects, because the file paths are relative to the project root. This also works for example for ESLint output, because it prints absolute paths. This does not work for tsc in mono repositories, because the output of yarn workspaces run tsc is relative to that workspace.

Examples

Clone and install a TypeScript mono repository.

git clone https://gitlab.com/remcohaszing/koas.git
cd koas
yarn

Let’s open the project using VSCode, since its builtin terminal is preconfigured to work with CTRL-click.

Run yarn workspaces run tsc in the VSCode terminal. This should work fine.

Now mess up any type. I changed an instance of koas.Middleware to koas.Middlewar in packages/koas-core/src/index.ts.

Run yarn workspaces run tsc in the VSCode terminal again. Now this outputs an error and a file path. The file path is not clickable, because it can’t be resolved.

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.
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 15時間
マージ済み PR(30日)
106

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

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

はじめの一歩

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

microsoft/TypeScript のほかの issue

microsoft/TypeScript の issue をすべて見る

似ている issue

Go の issue をもっと見る

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

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