TSDoc and TypeDoc link incompatibility when referencing exported members in a separate file that aren't imported
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
調査の方向性
Start by reading TSDoc’s reference parsing and validation entry points, then trace how {@link some/other/Component.default | Component} is parsed and why it raises tsdoc-reference-missing-hash. Compare that behavior with TypeDoc’s link format and identify whether this specific error can be disabled or the syntax supported. Done means TypeDoc links to unimported exported members work without the reported error; the issue names no files or tests.
索引モデルが issue の本文から書いたものです。
説明
When using TypeDoc to generate files, you can link to a file in two main ways.
You can use an imported module and link to it directly:
import Component from "@/some/other/Component"
/** {@link Component} */
Or, if it is not imported, you can link to it directly:
/** {@link some/other/Component.default | Component} */
This is an incompatibility with TSDoc's formatting, and will throw a tsdoc-reference-missing-hash error. Unless there is a way to disable this specific error, then TSDoc is unusable with TypeDoc if you want to link to a file that is not imported. I could find no workaround to resolve this incompatibility. The closest you can do is omit the ".default" from the link, but that is not a good solution, and wouldn't even work if that file exported another member.
- 主要言語
- TypeScript
- スター
- 5k
- フォーク
- 166
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/tsdoc のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
TokenReader subrange bounds enforced inconsistently: peekToken/peekPreviousTokenKind/backtrackToMarker ignore embedded window対応中かも @sylvesterkaczmarek が 54 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
microsoft/tsdoc の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
formbricks/formbricks#9918 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
thecodacus/pithagoras#364 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
openclimatefix/quartz-frontend#823 ·
メンテナーはふだん 4 日以内に返信
-
area:agent-manager community needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
`contacts.create` posts to `/audiences/undefined/contacts` when `audienceId` is undefined対応中かも @RaphaelFakhri が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
resend/resend-node#1176 ·
メンテナーはふだん 1 日以内に返信