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

Đang mở
#124 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
74/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
json, typescript
Lĩnh vực
tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
TypeScript
Star
0
Fork
6
Merge trung bình
1 ngày 21 giờ
Pull request đã merge (30 ngày)
8

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TMHSDigital/godot-correctness-mcp

Tất cả issue của TMHSDigital/godot-correctness-mcp

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.