microsoft / microsoft/TypeScript
Completion should suggest enum keys on some conditions
オープン
まだ誰も着手していません。
Awaiting More Feedback
Domain: LS: Completion Lists
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
🔍 Search Terms
"enum", "enum keys", "completion"
✅ 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
Suggest enum keys completions without having to spell out the enum identifier.
For example, input CRE should be offered completion State.CREATED.
This completion can be limited to places where the enum type is expected, like a function argument or an object literal.
📃 Motivating Example
enum State {
CREATED,
CLOSED,
}
function f(v : State) {}
f(CRE ) // Expect completion on CRE
💻 Use Cases
- What do you want to use this for? better DX
- What shortcomings exist with current approaches? Have to first write the enum before enum key completions are offered.
- What workarounds are you using in the meantime? no
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイル、テスト、エントリポイントは指定されていません。まず TypeScript language service の enum 補完の例を再現し、型が期待されるコンテキストで補完がどのようにフィルタリングされるかを追跡してください。CRE のようなプレフィックスで、先に enum 識別子を必要とせずに State.CREATED が提示され、既存の JavaScript の出力と動作が維持されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- developer-experience, tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100