microsoft / microsoft/TypeScript

Support import types in JSDoc links

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

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

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

説明

Bug Report

🔎 Search Terms
  • JSDoc
  • link / see
🕗 Version & Regression Information

4.3.0-dev.20210503

💻 Code

For some JavaScript:

// foo.js

export class Foo {}
// index.js

/**
 * {@link import('./foo').Foo Foo}
 * 
 * @param {import('./foo').Foo} foo 
 */
function withFoo(foo) { }
🙁 Actual behavior

The parameter type is resolved but the @link is not

🙂 Expected behavior

Both links should be resolved

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

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

はじめの一歩

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

調査の方向性

まず、index.js にある {@link import('./foo').Foo Foo} の例の JSDoc リンク処理から始め、動作している @param {import('./foo').Foo} のケースおよび foo.js のエクスポートされた Foo と比較します。パラメーター型と JSDoc リンクの両方が Foo に解決されれば完了です。

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

評価

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

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

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