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

Abierto
#118 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
1-2 días
Aptitud para principiantes
72/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
tooling

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
TypeScript
Estrellas
0
Forks
6
Merge medio
1 d 21 h
PR fusionados (30 d)
8

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TMHSDigital/godot-correctness-mcp

Todos los issues de TMHSDigital/godot-correctness-mcp

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.