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

Aberta
#124 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 2 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
74/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
json, typescript
Domínio
tooling

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
0
Forks
6
Merge médio
1d 21h
PRs com merge (30d)
8

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/godot-correctness-mcp

Todas as issues de TMHSDigital/godot-correctness-mcp

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.