Scene/project rule ids are free strings with no check against the catalogue

Offen
#118 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
72/100
Issue-Typ
Refactoring
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
typescript
Bereich
tooling

Rechercherichtung

Start with src/lint/catalog.ts and src/scenes/validate.ts, then trace the rule emitters named in the issue and the catalogue checks in src/lint/config.ts and src/lint/engine.ts. Run npm run build && npm test to establish the current behavior. Done when scene, project, and registry rule IDs are checked against the catalogue by TypeScript and their severities default from it.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

severity: low tech-debt

Summary

Scene, project and registry checks emit ruleId as free strings, while SCENE_RULES in the catalogue lists the same ids by hand. Nothing ties the two together.

Where

  • src/lint/catalog.ts:15-40 (SCENE_RULES: untyped tuples cast with as)
  • src/scenes/validate.ts:20-29 (finding(..., ruleId: string, ...)), plus the emitters in src/scenes/scene-graph.ts, src/scenes/node-paths.ts and src/scenes/input-actions.ts
  • src/lint/config.ts:37-41 (config rejects ids missing from RULE_INFO); src/lint/engine.ts:39 (routes on SCENE_RULE_IDS)

Why it hurts now

Adding a scene or project check means editing 2 to 3 files. A typo, or a forgotten catalogue entry, produces a rule that:

  • users cannot configure ("Unknown rule id"),
  • list_rules and the docs omit,
  • the lint engine may route wrongly.

TypeScript catches none of this. The two lists are in sync today (checked with grep), but only by hand.

Plan (each step leaves the code working)

  1. Add a test that greps src/scenes/** for (scene|project|registry)-[a-z-]+ ids passed to finding( and asserts each one is in RULE_INFO.
  2. Turn SCENE_RULES into an as const object keyed by id, and derive type SceneRuleId. Remove the as casts.
  3. Change finding() and the other emitters to take ruleId: SceneRuleId, and default the severity from the catalogue.
  4. Once the compiler enforces it, drop the step-1 test.

Getting started

  • Relevant files: src/lint/catalog.ts, src/scenes/validate.ts
  • How to run tests: npm run build && npm test

Filed by repo-audit/full-audit at e836036. Severity: low. Effort: S. audit-key: tech-debt|src/lint/catalog.ts|SCENE_RULES

Vorherrschende Sprache
TypeScript
Sterne
0
Forks
6
Ø Merge
1 T. 21 Std.
Gemergte PRs (30 T.)
8

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TMHSDigital/godot-correctness-mcp

Alle Issues in TMHSDigital/godot-correctness-mcp

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.