microsoft / microsoft/TypeScript

Support Closure Compiler-style @typedef

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

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

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

説明

Search Terms

  • Closure Compiler typedef

Suggestion

With Closure Compiler-style JSDoc, you name an @typedef type definition by introducing a var in the next statement:

/** @typedef {(string|number)} */
var NumberLike;

TypeScript doesn't recognize this construct. Instead, it wants you to write:

/** @typedef {(string|number)} NumberLike */

Use Cases

Migrating code written for use with Google's Closure Compiler over to TypeScript.

Examples

See above. My proposal is that, when prefixed with an @typedef with only a type (and no name), a variable definition would create a symbol in the type namespace in addition to the value namespace.

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
    → If the variable has the same name as an existing type, this would create a break. But this would indicate an issue if the two types disagreed.
  • 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 が Closure スタイルの JSDoc @typedef 宣言をどのように扱うかを追跡し、次に既存の名前付き形式と提案された変数ベースの形式を比較します。完了条件は、例が出力される JavaScript を変更せずに要求された型シンボルを作成することです。

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

評価

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

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

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