microsoft / microsoft/TypeScript

Expose more internal api for making language service plugins.

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

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

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

説明

Search Terms

language service plugin api refactor codefix vscode

Suggestion

  • ts.refactor.registerRefactor
    A more standard way to make refactor rather than hook the language servies functions.
    And refactor is a rare api that I do not need to write ui code or command for vscode.
  • ts.textChanges.*
    Use this, I can easily generate code or modify code that conform the current code format style.
    Especially you don't expose the ts.formatting.*
  • ts.TypeChecker.getTrueType() ts.TypeChecker.getFalseType()
    The TypeFlags.BooleanLiteral is not enough to determine it is true or false.

Use Cases

https://github.com/heroboy/generate-typescript-switch-case-for-enum-type-language-service-plugin

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 番号を参照したプルリクエストを送ります。

調査の方向性

まず TypeScript language service plugin の API と、要求されたエントリーポイントである ts.refactor.registerRefactor、ts.textChanges.、ts.formatting.、TypeChecker.getTrueType()/getFalseType() を確認します。これらを、リンクされている generate-typescript-switch-case-for-enum-type-language-service-plugin のユースケースと比較します。完了条件は、列挙されたすべての要求を実装することではなく、スコープが定められ合意された public API の提案です。

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

評価

技術スタック
typescript
領域
compilers, devtools
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
20/100

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

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