microsoft / microsoft/TypeScript
Codefix: convert `Type[]` to `readonly Type[]`
オープン
まだ誰も着手していません。
Awaiting More Feedback
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
Search Terms
codefix readonlyarray readonly array immutable
Suggestion
It'd be nice to have a codefix for converting non-readonly arrays to readonly.
Use Cases
When converting/refactoring code to be more immutable/readonly-friendly, it's a bit of a pain to manually add these annotations.
Examples
Given this:
function takesArrays(items: /*| |*/string[], moreItems: /*| |*/string[]) { /* ... */ }
...having a codefix to make one or all parameters readonly would be useful:
function takesArrays(items: readonly string[], moreItems: readonly string[]) { /* ... */ }
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
issue の TypeScript の例と、関連する型注釈用の既存の codefix インフラストラクチャから始めます。codefix のエントリポイントとそのテストを特定し、該当する 1 つまたはすべてのパラメーターの変換を実装して、結果の型が readonly 配列構文を使用していることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers, tooling
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100