microsoft / microsoft/TypeScript
Support typedef inheritance with JSDoc
オープン
まだ誰も着手していません。
Domain: JSDoc
In Discussion
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
TypeScript Version: 2.7.0-dev.20171116
Code
/**
* @typedef {Object} Base
* @property {String} baseProp
*/
/**
* @typedef {Base} Child
* @property {String} childProp
*/
/** @type {Child} */
const child = { baseProp: '' };
Expected behavior: Error. child is missing the childProp property.
Actual behavior: No error. The Child type is identical to the Base type and only requires a baseProp property. The childProp property definition is completely ignored.
Or maybe there's another way to do the equivalent of interface Child extends Base here?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、issue にある JSDoc typedef の例を再現し、TypeScript が typedef の継承と @property 宣言をどのように処理するかを追跡します。完了条件は、checker が Child に childProp がないと報告すること、またはサポートされている interface Child extends Base 相当の機能を文書化して実装することです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 45/100