microsoft / microsoft/TypeScript
Warn about invalid triple slash directive location.
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
🔍 Search Terms
"triple slash directive warning", "triple slash directive", "triple slash"
✅ Viability Checklist
- 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 isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
Provide a warning when triple slash directives are found places where they are ignored.
eg.
import { AudioBuffer } from '@/audio/AudioBuffer';
/// <reference lib="WebWorker" />
Typescript could emit a warning on line 3 "triple slash directive is ignored due to not being first" and a quick fix to move it to the top.
This would provide clarity in the case that people don't remember (or haven't read) the docs.
📃 Motivating Example
I just spent 20 minutes with a file equivalent to the above trying to work out why the webworker types would only get included when i commented out my import statements. I thought it was some problem with imports specifically.
💻 Use Cases
- What do you want to use this for?
Save time trying to search for the wrong problem. - What shortcomings exist with current approaches?
People don't always read or remember what's documented. - What workarounds are you using in the meantime?
n/a
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ソースファイルやテストは指定されていません。まず、triple-slash directives を処理するコンパイラの処理箇所と、関連する language-service の quick-fix インフラストラクチャを探してください。完了条件は、無視されたディレクティブが指定された文言の警告を生成し、それらを先頭に移動する修正を提示し、ディレクティブより前に import がある例をカバーすることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100