README and docs advertise features that the published 0.1.2 does not have

Aperta
#61 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
38/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
node.js, typescript

Direzione di ricerca

Read the listed README.md and docs snippets alongside CHANGELOG.md, ROADMAP.md, and package.json; compare their claims and version ranges with the published 0.1.2 behavior described in the issue. Check the release workflow and relevant tags to confirm what is shipped. Done means the docs and CI snippets match available releases, and the changelog and roadmap accurately reflect shipped features.

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

Descrizione

documentation severity: high

Summary

SARIF output, baselines, inline suppressions, removed-api-usage, uid resolution, the deeper scene checks and the input-action check have all landed on main since v0.1.2, which is still npm latest. These features sit under [Unreleased] in the CHANGELOG. The README and docs snippets run npx -y -p @tmhs/godot-correctness-mcp gdcorrect ... without a version, so users get 0.1.2, and the copy-paste CI recipes either fail or silently do nothing.

Where

  • README.md:71-120 (CLI and CI section)
  • docs/lint.md:65-116 (removed-api-usage, suppressions, CI)
  • docs/scenes.md (scene, uid and input-action rule tables)
  • CHANGELOG.md:7-23, CHANGELOG.md:51
  • ROADMAP.md:22-31

Details

In 0.1.2, parseArgs only knows --format/-f, and the format check rejects anything except json or pretty. That gives these results:

  • The README SARIF workflow exits 2 with Unknown format: sarif. continue-on-error hides the failure, and upload-sarif then fails on a missing file.
  • --write-baseline / --baseline are treated as positional arguments and ignored. No baseline is written, so the CI gate fails on every existing finding.
  • Inline suppressions and removed-api-usage are silently ignored.
  • The scene/uid/input-action checks listed in docs/scenes.md are never reported.

Related staleness:

  • CHANGELOG.md lists "Added THIRD_PARTY_NOTICES.md" under 0.1.1, but the file is not in the v0.1.1 or v0.1.2 tags; it was added after 0.1.2. The same line also appears under Unreleased.
  • Most unchecked items in ROADMAP.md v0.2.0/v1.0.0 are already implemented: suppressions, SARIF, baseline, uid, scene checks, input actions, removed-API rule and node-path validation. Only signal-callback-arity and the stable JSON contract remain.

Suggested fix

Cut the release: npm version minor --no-git-tag-version, move [Unreleased] to [0.2.0], and push so release.yml tags and publishes it. Pin the snippets to @tmhs/godot-correctness-mcp@^0.2. Also fix the CHANGELOG 0.1.1 line and tick the ROADMAP items.

Acceptance criteria

  • npm latest contains every feature documented in README/docs, or the docs mark each one with its minimum version
  • The CI snippets pin a version range
  • The CHANGELOG and ROADMAP match what is actually shipped

Related: #26
Related: #33
Related: #34
Related: #53

Getting started

  • Relevant files: README.md, docs/lint.md, docs/scenes.md, CHANGELOG.md, ROADMAP.md, package.json
  • How to run tests: npm run build && npm test (and npm run typecheck)
  • Related docs: CONTRIBUTING.md, AGENTS.md

Filed by repo-audit/full-audit at 5d49f5d. Severity: high. Effort: S. audit-key: documentation|README.md|CLI and CI

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.