CLI --baseline flattens JSON payloads and resolves paths differently from MCP tools

Aperta
#103 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
api, cli

Direzione di ricerca

Start with the baseline handling in src/cli.ts:364-381 and compare it with the MCP handlers in src/tools/scenes.ts and src/tools/lint.ts; then read src/baseline.ts to trace how relative paths are resolved. The proposed parity test belongs in test/tools.test.ts, alongside the existing CLI shape assertion in test/cli.test.ts. Done means every listed command preserves its payload shape, CLI and MCP agree on baseline behavior, the path rule is consistent or documented, and the CHANGELOG records the JSON shape change.

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

Descrizione

bug help wanted severity: medium

Summary

With --baseline, the CLI replaces every command's JSON payload with a generic {root, findings, count, baselined, staleBaselineEntries}. With a baseline argument, the MCP tools keep each command's own shape. Relative baseline paths also resolve differently: against the cwd in the CLI, and against the project root in MCP. Two hand-written "apply baseline" implementations have already drifted.

Where

  • src/cli.ts:364-381 (generic payload replacement)
  • src/baseline.ts:105-108, src/baseline.ts:133-141 (readBaseline uses the cwd; baselineFindings uses the root)
  • src/tools/scenes.ts:26-30, src/tools/scenes.ts:79-85, src/tools/scenes.ts:97-120; src/tools/lint.ts:62-76
  • test/cli.test.ts:147-155 (asserts the flat shape); the parity test at test/tools.test.ts:131 runs only without a baseline

Details

if (baseline) {
  const r = applyBaseline(root, res.findings, readBaseline(baseline));
  res = { root, findings: r.newFindings,
          payload: { root, findings: r.newFindings, count: r.newFindings.length,
                     baselined: r.baselined, staleBaselineEntries: r.stale } };

With a baseline:

  • gdcorrect report loses the scenes/project/registries/lint categories, registryEntries and the severity counts.
  • lint loses godotVersion, fileCount and the counts.
  • validate-registries loses entries.

MCP project_report and lint_project keep their shape and recompute the counts. MCP validate_registries keeps entries but has no count.

Impact

Scripts that parse gdcorrect ... --format json break, or read undefined, as soon as a baseline is added. The per-command JSON shapes in the docs only hold without a baseline. One baseline file cannot be referenced with the same relative path from CI and from an agent: game/.gdbaseline.json from the repo root, versus the MCP root-relative game/game/....

Suggested fix

Incremental plan:

  1. Add a parity test. For each of lint, validate-scenes, validate-project, validate-registries and report, compare CLI --baseline JSON with the matching MCP tool output given baseline.
  2. Add a severityCounts(findings) helper and replace the five hand-written copies (src/cli.ts, src/lint/project.ts, src/scenes/report.ts, src/tools/lint.ts, src/tools/scenes.ts).
  3. Move the per-command "apply baseline, keep shape, add baselined/staleBaselineEntries" logic into one shared module, used by both runCommand and the tool handlers.
  4. Delete the generic payload in cli.ts, and add count to the registries payload.
  5. Choose one resolution rule for relative baseline paths and document it. Root-relative is what MCP already documents.

Acceptance criteria

  • CLI and MCP JSON are identical for every command, with and without a baseline.
  • The resolution rule for relative baseline paths is the same in both front ends, or the difference is documented in --help and README.
  • CHANGELOG notes the CLI JSON shape change.

Filed by repo-audit/full-audit at e836036. Severity: medium. Effort: M. audit-key: bug|src/cli.ts|runCli.baseline-payload

Lingua principale
TypeScript
Stelle
0
Fork
6
Merge medio
1g 21h
PR unite (30g)
8

Preparare l'ambiente

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 TMHSDigital/godot-correctness-mcp

Tutte le issue di TMHSDigital/godot-correctness-mcp

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.