microsoft / microsoft/TypeScript

JSDoc: Typescript is interpreting varargs in function signature as required argument if jsdoc function notation is used in typedef.

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

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

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

説明

TypeScript Version: typescript@3.4.0-dev.20190308

Search Terms: jsdoc, varargs, typedef,

Code

// if I want to use typescript format
// this format is not supported by WebStorm
/** @typedef {(...a2:Array<string>) => void} A */
/** @type {A} */
let a;
a(); // but this works fine with typescript

// if I want to use JSDoc format
// this format is supported by WebStorm
/** @typedef {function(...string):void} B */
/** @type {B} */
let b;
b(); // but this not work, TS2555: Expected at least 1 arguments, but got 0

Expected behavior:
Both formats should be interpreted in same way.

Actual behavior:

test.js:13:1 - error TS2555: Expected at least 1 arguments, but got 0.
13 b(); // but this not work, TS2555: Expected at least 1 arguments, but got 0
   ~~~
  test.js:10:24
    10 /** @typedef {function(...string):void} B */
                              ~~~~~~~~~
    An argument for '0' was not provided.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

issue の最小限の JavaScript 再現例から始め、TypeScript が 2 つの JSDoc typedef 形式をどのように扱うかを比較します。varargs パラメーターと TS2555 診断に重点を置いてください。両方の形式で、引数なしで結果の関数を呼び出せるようになり、同等の動作をカバーするテストがあることを完了条件とします。

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

評価

技術スタック
javascript, typescript
領域
compilers
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

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

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