microsoft / microsoft/TypeScript

better autocompletion for dicriminated union as tuples

オープン
#31,977 コメント 0 件 リアクション 7 件 担当者 0 名 GitHub で見る

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

Experience Enhancement Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

Search Terms

autocompletion, tuple, tagged union

Suggestion

Use Cases

https://www.typescriptlang.org/docs/handbook/advanced-types.html#discriminated-unions
Discriminated unions of tuples is just the same in semantic with discriminated unions with object introduced in the official document of typescript.
And the type check for it is working correctly for now.
But the autocompletion for tuples isn't as powerful as one for objects.
Sometimes discriminate unions as objects are verbose so it leads us to write some sort of constructors for each variant. But tuples can solve this problem, and it even looks more similar to haskell's data and rust's enum.

Examples

// discriminated union as tuples
type A = ["a", { a: number }] | ["b": { b: number }];
const a: A = ["a", { /* both a and b are suggested when you fill in here */ }];
const b: A = ["b", { a: 1 }]; // type check works correctly! typescript tell us it's invalid.

// discriminated union as objects
type C = {
    tag: "a",
    a: number
} | {
    tag: "b",
    b: number
};
const c: C = { tag: "b", /* only b is suggested! */ };

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.

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

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

はじめの一歩

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

調査の方向性

Issue にリンクされている TypeScript ハンドブックの「discriminated-unions」セクションから始め、tuple の例と object の例を比較してください。tuple の discriminated unions が object 形式と同様にバリアント固有の自動補完を提供し、既存の型チェック動作を維持できれば、作業は完了です。

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

評価

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

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

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