Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

LSP: self-explaining diagnostics and richer requirement hover

Aperta
  • Qualcosa non va?
#386 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
backend-api-design, devtools

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

  1. Diagnostic.codeDescription.href pointing at the rule's documentation anchor, so the code is a link in editors that support it.
  2. 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.
  3. 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.
  4. Rich requirement hover: the requirement text (first lines), status, reqDomain, parents and child count, satisfiers, and the verification state in the same vocabulary as coverage tree (verified / planned / uncovered) with the last recorded test verdicts.
  5. Severity and tags: map I-class findings to Information and gate-able warnings to Warning; mark DiagnosticTag.Deprecated for deprecated keys (W075).
  6. 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 relatedInformation pointing at the other element.
  • The hover of a verified requirement shows verified and its latest test verdicts; an uncovered one shows uncovered.

Part of #272. Scope: syscribe lsp only (standard LSP, ADR-SYS-LSP-001).

Generated by Claude Code

Lingua principale
JavaScript
Stelle
8
Fork
1
Merge medio
1h
PR unite (30g)
83

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di sjames/syscribe

Tutte le issue di sjames/syscribe

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.