Ship a JSON Schema for godot-correctness.config.json

Ouverte
#124 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
74/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
json, typescript
Domaine
tooling

Piste de recherche

Read src/lint/config.ts, package.json, and the existing drift test for mcp-tools.json; inspect the build scripts and config example to see how schemas are generated and packaged. Run npm run build && npm test to check the current setup. Done when the generated schema includes the rule ID enum, ships in the package, is referenced by the example config, and the drift test passes.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

enhancement severity: medium

Summary

The config accepts a $schema key as a pointer for editors (src/lint/config.ts:25), but the package ships no JSON Schema to point it at.

Where

  • src/lint/config.ts:24-25
  • godot-correctness.config.example.json
  • docs/lint.md

Proposal

  • Generate schema/config.schema.json from the zod schema at build time (zod 4 z.toJSONSchema), with an enum of rule ids from the catalogue.
  • Add it to the package files, reference it from the example config, and add a drift test like the existing mcp-tools.json one.

Who benefits

Users editing the config get autocomplete and validation for rule names and options in their editor, which catches the typos that strict config validation (#63) only reports at run time.

Getting started

  • Relevant files: src/lint/config.ts, scripts/, package.json
  • How to run tests: npm run build && npm test

Filed by repo-audit/full-audit at e836036. Severity: medium. Effort: S. audit-key: enhancement|src/lint/config.ts|$schema

Langage dominant
TypeScript
Étoiles
0
Forks
6
Merge moyen
1 j 21 h
PR mergées (30 j)
8

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/godot-correctness-mcp

Toutes les issues de TMHSDigital/godot-correctness-mcp

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.