microsoft / microsoft/TypeScript

Suggest argument names based on type definition of callback functions

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

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

Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

Search Terms

callback, arguments, parameters, suggestion, auto correct

Suggestion

Let's say I have a type definition for my function like this:

function acceptsCallback(callback: (argumentNameThatIsVeryLong: string) => void) {}

When using it, that argumentNameThatIsVeryLong is a very good candidate for my argument name. I want to accept it but there is no way but typing it:

Screen Shot 2020-08-31 at 5 22 34 PM

Use Cases

When users are extremely lazy this is very handy! ;) In all seriousness this can avoid bugs by suggesting the right argument name. For instance when req and res objects are misplaced in an Express middleware by mistake

Examples

https://www.typescriptlang.org/play?#code/GYVwdgxgLglg9mABAQwhApgBygZwMLIA2hARqgNYAUERpFAXIpcgE4DmIAtumFAHLJuAFQAWyKAEkcANXQsAngBkEbRjigsYYNgEpEAXgB8iAG5wYAEz0BvAL4Aoe6gzZ8tMhCqPv95ux32OkA

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 Playground の例から始めて、エディターでコールバックパラメーターの候補が現在どのように動作するかを確認してください。コールバック型定義の引数名が候補として提示され、出力される JavaScript が変更されなければ完了です。

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

評価

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

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

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