Add a consistency check for registry.json, game folders and trophies

Đang mở
  • Có gì không ổn?
#31 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
55/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ệ
typescript, vite
Lĩnh vực
devtools, testing

Hướng nghiên cứu

Start by reading games/registry.json, vite.config.ts, shared/achievements.ts, and scripts/new-game.mjs to trace how game folders, registry entries, and trophies are connected. Add the consistency checks in games/registry.test.ts, then make the scaffold function testable with a temporary directory. Done means the listed validation and scaffold cases pass in CI; the issue says there is no test suite yet, so first identify the project’s test setup.

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

Mô tả

help wanted severity: medium testing

Summary

The list of games has three independent sources of truth and nothing ties them together: Vite builds pages from a folder scan, the hub lists games from registry.json, and the "play every game" trophy derives the game set from the trophy list. They agree today; this is a drift risk.

Where

  • vite.config.ts:10-19 (discoverGames)
  • games/registry.json, src/hub/main.ts:46 (unchecked cast)
  • shared/achievements.ts:143-144
  • scripts/new-game.mjs:7-44 (runs at module top level, so it cannot be pointed at a fixture directory)

Impact

A registry slug with no folder is a dead hub card. A folder with no registry entry is built and precached but unreachable. A game with no trophy is silently not required for the "play every game" trophy.

Suggested fix

Add games/registry.test.ts (and optionally the same check at build time in vite.config.ts):

  • Slugs are unique and match /^[a-z0-9]+(-[a-z0-9]+)*$/
  • The slug set equals the set of games/* folders that do not start with _ and contain index.html
  • Every entry has a non-empty title, description, controls and tags, and a six-digit hex accent
  • Every thumbnail resolves to a file under public/
  • Every non-arcade trophy's game is a registry slug, and every slug has at least one trophy
  • Trophy ids are unique; counter and target are both set or both absent

Then export scaffold({ root, slug, title }) from new-game.mjs with a thin CLI wrapper and test it against a temp directory:

  • Invalid and existing slugs are rejected with no writes
  • space-dodge with no title becomes "Space Dodge"
  • No placeholder remains in the copied files; the registry gains exactly one entry and stays valid JSON

Acceptance criteria

  • The cases above pass in CI

Getting started

  • Relevant files: games/registry.json, vite.config.ts, shared/achievements.ts, scripts/new-game.mjs
  • Run locally: npm install, then npm run dev
  • Checks: npm run typecheck and npm run build (there is no test suite yet)
  • Related docs: README.md

Filed by repo-audit/full-audit at b001f5d. Severity: medium. Effort: M. audit-key: testing|games/registry.json|registry-consistency

Ngôn ngữ chính
TypeScript
Star
3
Fork
3
Không có pull request nào được merge trong 30 ngày

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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/GH-Arcade

Tất cả issue của TMHSDigital/GH-Arcade

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.