QLDoc view omits `<code>` HTML elements
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- typescript
調査の方向性
VSCode拡張機能で提供されたQLDocの例にカーソルを合わせ、クエリファイルで問題を再現します。QLDocのホバー／レンダリング経路を追跡し、code要素のコンテンツが省略される理由を特定します。レンダリングされたQLDocにコンテンツが表示され、できればコードのフォーマットも適用され、表示される他のHTML要素にリグレッションがない状態を完了とします。
索引モデルが issue の本文から書いたものです。
説明
Describe the bug
According to the language specification QLDoc uses CommonMark, which supports raw HTML.
It appears that the VSCode extension supports HTML entity references (e.g. *), and for some HTML elements simply shows their content without any special formatting (e.g. <b>bold</b>).
However, <code> elements are apparently completely omitted, not even their content is shown:
My use case is that I would like to write /** ... */ (a Javadoc comment) in a QLDoc, however */ is recognized as end of the QLDoc. Therefore the only workaround might be to use <code>/** ... */</code>.
But this is not super important, I could probably also just omit */ from my QLDoc comment.
To Reproduce
- In a query file write the following QLDoc comment or add it to an existing element
/** * Test <code>code</code> */ <b>bold</b> <i>italic</i> */ - Hover over the QLDoc
❌ The text "code" is completely missing from the shown rendered QLDoc
Expected behavior
- At least the content of the
<code>element should be shown in the rendered QLDoc (similar to how it is the case for<b>) - Or ideally the content of the
<code>element is shown and formatted as code
Additional context
The LGTM Query Console seems to support <code> and even formats the text as code in the preview when hovering over a documented element:
- 主要言語
- TypeScript
- スター
- 539
- フォーク
- 240
- 平均マージ
- 2日 18時間
- マージ済み PR（30日）
- 37
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/vscode-codeql のほかの issue
-
bug VSCode
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/vscode-codeql#4471 · コメント 1 件 ·
-
bug enhancement VSCode
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/vscode-codeql#592 · コメント 2 件 ·
-
enhancement VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
github/vscode-codeql#4432 · コメント 1 件 ·
-
bug VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
github/vscode-codeql#4356 ·
-
bug VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
github/vscode-codeql#4339 · コメント 1 件 ·
github/vscode-codeql の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
bug v2
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
modelcontextprotocol/inspector#2458 · コメント 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
carbon-design-system/ibm-products#9907 ·