microsoft / microsoft/TypeScript
JSDoc type reference doesn't skip leading asterisk
オープン
まだ誰も着手していません。
Bug
Domain: JSDoc
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
TypeScript Version: typescript@3.6.0-dev.20190704
Search Terms:
checkjs
jsdoc
multi-line
multiline
Code
/**
* @returns {
* | 'a'
* | 'b'
* | 'c'
* } - this type is parsed as `any`.
*/
function f() {
return true;
}
Expected behavior:
Error on incompatible return type.
Actual behavior:
No error. The jsdoc return type is parsed as any.
Playground Link:
Not available.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
報告にある複数行の JSDoc @returns の例で問題を再現し、TypeScript の JSDoc 型解析パスを調査します。先頭のアスタリスクがスキップされ、互換性のない boolean の戻り値が型を any として扱うのではなくエラーになることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 45/100