LSP: self-explaining diagnostics and richer requirement hover
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- javascript
調査の方向性
Start with the syscribe lsp implementation and the embedded rule catalogue, then review prompts/spec/validation.md, docs/validation/rules.md, ADR-SYS-LSP-001, and the existing LSP tests. The acceptance criteria describe checks for diagnostic links and explanations, related locations, and requirement hover verification details. Done means those behaviors are covered by tests and explanations come from the embedded catalogue.
索引モデルが issue の本文から書いたものです。
説明
Part of #380.
Current state
Hover shows type, id, qualified name and status. A diagnostic shows the code and message but not what the code means, why it matters, or how to resolve it; the explanation exists (explain_finding over MCP, the rule catalogue prompts/spec/validation.md, docs/validation/rules.md) but is not reachable from the editor.
Proposal
Diagnostic.codeDescription.hrefpointing at the rule's documentation anchor, so the code is a link in editors that support it.- Related information where a finding involves another element (
relatedInformation: the conflicting duplicate id, the parent that lacks the ADR, the escaping reference's target), each a location the user can jump to. - Hover on a diagnostic range appends the catalogue explanation: what the rule checks, the usual cause, the usual fix, and the quick fix if one exists.
- Rich requirement hover: the requirement text (first lines), status,
reqDomain, parents and child count, satisfiers, and the verification state in the same vocabulary ascoverage tree(verified / planned / uncovered) with the last recorded test verdicts. - Severity and tags: map
I-class findings to Information and gate-able warnings to Warning; markDiagnosticTag.Deprecatedfor deprecated keys (W075). - Source of truth: take the catalogue text from the embedded rule catalogue, never a second copy; a test fails if an emitted code lacks an explanation.
Acceptance (tests first)
- A diagnostic carries
codeDescription.href, and the hover on it contains the catalogue explanation. - A duplicate-id finding carries
relatedInformationpointing at the other element. - The hover of a verified requirement shows
verifiedand its latest test verdicts; an uncovered one showsuncovered.
Part of #272. Scope: syscribe lsp only (standard LSP, ADR-SYS-LSP-001).
Generated by Claude Code
- 主要言語
- JavaScript
- スター
- 8
- フォーク
- 1
- 平均マージ
- 3時間 13分
- マージ済み PR（30日）
- 61
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
sjames/syscribe のほかの issue
-
Format-preserving writes for structural frontmatter (features, connections, layout, shapes, edges)オープン
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
sjames/syscribe#405 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
sjames/syscribe#398 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
sjames/syscribe の issue をすべて見る
似ている issue
-
[guide] AGENTS.md claims the coverage gate, e2e and full lint run on every PR after ADR 0011 focused validation対応中かも @hivecommons-hive が今日担当しました。 オープンagent/guide documentation hive/claimed-by-guide stage/040-covered-by-pr
難易度 2/5 1〜3時間 初心者へのやさしさ 81/100
cncf/endusers#2006 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
check:passed feeds:add
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 4 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
all-contributors/cli#587 ·
メンテナーはふだん 1 日以内に返信
-
RGAA5
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 8 日以内に返信
-
feedback simulation workshop
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
githubnext/gh-aw-workshop#5157 ·
メンテナーはふだん 1 日以内に返信