Move trophy definitions next to each game and type trophy ids

未关闭
#38 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
重构
描述清晰度
描述清楚
活跃度
活跃
技术栈
typescript, vite

调研方向

Start with shared/achievements.ts and games/registry.json to understand the trophy list and game registry, then read src/hub/trophies-panel.ts for how games without trophies are displayed. The issue proposes four steps, including adding tests despite noting that no test suite exists; first run npm run typecheck and npm run build to establish the baseline. Done means mistyped trophy IDs fail typechecking and adding a game no longer requires editing shared/achievements.ts.

由索引模型根据 Issue 内容生成。

描述

severity: medium tech-debt

Summary

All 43 trophies live in one hand-maintained list in a shared module, so every new game edits shared code, and the set of games is stated twice (registry and the trophy list). Trophy ids are bare strings at call sites.

Where

  • shared/achievements.ts:22-76, shared/achievements.ts:110-111, shared/achievements.ts:143-144
  • src/hub/trophies-panel.ts:26-27 (games with no trophies are skipped, hiding their stats)

Impact

  • A mistyped id in unlock('...') compiles and silently never unlocks.
  • A game added without trophies is excluded from the "play every game" trophy and from the stats panel.
  • shared/achievements.ts changes in every game-add commit.

Suggested fix

Each step leaves the build working:

  1. Add tests for unlock, addCounter, recordPlay and a registry consistency test.
  2. Derive a TrophyId union from the list (as const) and type unlock(id: TrophyId). No behaviour change.
  3. Move each game's rows to games/<slug>/trophies.ts and build the list with import.meta.glob (Phaser-free, so the hub still loads it cheaply).
  4. Derive the "play every game" set from the registry, and render a stats-only section for games with no trophies.

Acceptance criteria

  • A mistyped trophy id fails typecheck
  • Adding a game does not require editing shared/achievements.ts

Getting started

  • Relevant files: shared/achievements.ts, games/registry.json, src/hub/trophies-panel.ts
  • 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

Related: #1


Filed by repo-audit/full-audit at b001f5d. Severity: medium. Effort: M. audit-key: tech-debt|shared/achievements.ts|TROPHIES

主要语言
TypeScript
星标
3
派生
3
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TMHSDigital/GH-Arcade 的其他 Issue

查看 TMHSDigital/GH-Arcade 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。