microsoft / microsoft/TypeScript

@see for property ref in __type__ reference

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

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

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

説明

Suggestion

🔍 Search Terms

jsdoc tsdoc @see @link docs types

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • 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, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

📃 Motivating Example

export type A = {
  /**
   * The import ID from which the re-export was imported from.
   */
  foo: string
}

export namespace A {
  export type Params = {
    /**
     * @see {@link A['foo']}
     */
    foo: string
  }
  
  export const create = (params:Params): A => {
      return 'todo' as any
  }
}

Here is the above code (approx) in an interactive VSC setting, note the following:

  1. Want to navigate to type alias but it goes to namespace
  2. Want to point at a specific property, cannot

CleanShot 2021-07-13 at 19 44 06

I do not have a concrete suggestion yet about how to achieve this.

First want to validate the problem with others.

💻 Use Cases

Want to share the JSDoc between a property on a constructor and a data type.

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

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

はじめの一歩

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

調査の方向性

VS Code で動機となった例を再現し、A['foo'] への JSDoc @see/@link 参照が namespace に対してどのように解決されるかを比較します。まず報告されたナビゲーションの挙動を検証し、具体的な構文または解決ルールを決定してください。特定のプロパティを指し、そのドキュメントを共有するためのアプローチについて合意できれば完了です。

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

評価

技術スタック
javascript, typescript
領域
compilers, developer-experience
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
15/100

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

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