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

オープン
#118 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
リファクタリング
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript
領域
tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
TypeScript
スター
0
フォーク
6
平均マージ
1日 21時間
マージ済み PR(30日)
8

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TMHSDigital/godot-correctness-mcp のほかの issue

TMHSDigital/godot-correctness-mcp の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。