Keep diagnostic codes in one registry and check spec Appendix A against it

Abierto
  • ¿Algo no está bien?
#38 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
backend, cli, documentation, testing

Línea de trabajo

Start with packages/engine/src/diagnostics.ts and packages/engine/src/types.ts to trace diagnostic definitions, then follow the CLI emitters in packages/cli/src/commands/check.ts and packages/cli/src/generate/verify.ts. Read docs/spec/content-pack.md Appendix A and compare its codes and severities with the registry. Done means unregistered codes are rejected, CI detects any Appendix A mismatch, and both packs retain their current lexvm check --json output.

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

Descripción

area: cli area: engine priority: medium type: chore

Context

Diagnostic codes are a public contract: LLM repair loops, --json consumers and the documentation rely on them. Today they are string literals spread over the compiler, analyzer, verifier, play-time estimate, lexvm check (check.*) and lexvm generate (verify.*), and Appendix A of the specification is maintained by hand. Engine and CLI codes had to be aligned by hand during v0.1, and before the v0.1 pull request Appendix A was completed by diffing it against every code literal in packages/engine/src and packages/cli/src; that check cannot be repeated automatically. verify.<gate>-crashed and yaml.<code> are built from templates.

Scope

  • One registry in the engine: code, severity, stage and a one-line meaning. Emitters use typed constants; the yaml.<code> and schema.<code> families are registered as prefixes.
  • CLI codes come from the same registry.
  • A test or generator that keeps Appendix A and the registry identical (codes and severities).

Acceptance criteria

  • Emitting an unregistered code fails the typecheck or a test.
  • CI fails when Appendix A and the registry disagree.
  • No code or severity changes for existing packs: lexvm check --json output for both packs is unchanged.

References

  • packages/engine/src/diagnostics.ts
  • packages/engine/src/types.ts (Diagnostic)
  • packages/cli/src/commands/check.ts
  • packages/cli/src/generate/verify.ts
  • docs/spec/content-pack.md (Appendix A)
Lenguaje dominante
TypeScript
Estrellas
0
Forks
0
Merge medio
1 h 24 min
PR fusionados (30 d)
5

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 nullthrone/lexvm

Todos los issues de nullthrone/lexvm

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.