Generate the shared head of each game's index.html at build time

Aperta
#44 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
html, typescript, vite
Ambito
build-system

Direzione di ricerca

Read vite.config.ts and compare games/_template/index.html with games/snake/index.html; check how games/registry.json stores each title. Start by tracing the Vite build entry points, then add the suggested build test for every game's built page. Done means the shared head is defined once and the built pages retain their titles, icon links and font stylesheet.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

severity: low tech-debt

Summary

Each game's index.html repeats the same viewport, theme colour, icon links, font preconnect and stylesheet, back link, loader and script tag. Only the title differs, and the title is also in the registry.

Where

  • games/_template/index.html:1-20, games/snake/index.html:7
  • vite.config.ts:10-19

Details

The template and Snake were compared line by line; the others are the same length and were sampled.

Impact

Any head change (font swap, manifest link, meta description, a CSP tag) is an eleven-file edit that can drift.

Suggested fix

Add a small Vite transformIndexHtml plugin that injects the shared head tags and the title from games/registry.json, and reduce each game's index.html to the body. Cover it with a build test asserting each built page has the title, icon link and font stylesheet.

Acceptance criteria

  • Shared head tags are defined in one place
  • Built pages are unchanged

Getting started

  • Relevant files: games/_template/index.html, vite.config.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

Filed by repo-audit/full-audit at b001f5d. Severity: low. Effort: S. audit-key: tech-debt|games/_template/index.html|head

Lingua principale
TypeScript
Stelle
3
Fork
3
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/GH-Arcade

Tutte le issue di TMHSDigital/GH-Arcade

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.