microsoft / microsoft/TypeScript

Encapsulate type refactoring

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

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

Awaiting More Feedback Domain: LS: Refactorings Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

Search Terms

  • refactoring
  • encapsulate
  • return, function

Suggestion

Add a refactoring that encapsulates a given instance of a type and updates uses of it. Encapsulating would wrap the type in an object type that has a single property of that type.

Use cases

My original use case would be to convert a single returned type to an object that can return multiple values:

  1. Start
    function foo(): number { return Date.now(); }
    const z = foo(); 
    
  2. Select number and run encapsulate
  3. Result
    function foo(): { value: number } { return { value: Date.now() }; }
    const z = foo().value; 
    

This could also be used for individual parameters in a function:

  1. Start
    function foo(x: number) { return x * 2; }
    foo(1);
    
  2. Select number and run encapsulate
  3. Result
    function foo(x: { value: number }) { return x.value * 2; }
    foo({ value: 1 });
    

This may fall under some larger class of refactoring, I'm just not sure what to call it

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

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

はじめの一歩

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

調査の方向性

この issue ではファイルもテストも指定されていないため、foo の戻り値型とパラメーターの例を受け入れ条件として使用します。まず、リポジトリに既存するリファクタリングのエントリーポイントとテストを確認します。Encapsulate アクションが選択した戻り値型と関数パラメーターの両方を変換し、示されている呼び出し箇所を更新して、結果の { value: ... } 形式を使用するようになれば完了です。

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

評価

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

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

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