imjasonh/nescript
1
0
Fork 0
mirror of https://github.com/imjasonh/nescript synced 2026-07-08 08:55:38 +00:00
Code Activity

docs: regenerate platformer.gif and lock it as a CI invariant

Browse source 
The optimizer fix in the previous commit changes the observable
gameplay of `examples/platformer.ne` — pre-fix the player got
spurious enemy-1 stomp bounces every time coin 2 drifted into its
pickup window, so the README demo gif showed the player bouncing
mid-air around emu frames 85-125 instead of walking through the
coin at ground level. Regenerate `docs/platformer.gif` from the
fixed compiler so the README matches reality.

To stop this from drifting again, treat the gif the same way the
repo already treats `examples/*.nes`:

- `gifenc` + `jsnes` + the harness are deterministic, so a fresh
  recording byte-matches a valid commit. Verified across two
  back-to-back runs (identical md5).

- `.github/workflows/ci.yml`'s `emulator` job now renders the gif
  into `/tmp/platformer.gif` and `cmp`s it against `docs/platformer.gif`,
  emitting a `::error` annotation pointing at the exact rerun
  command if the committed copy is stale. This piggybacks on the
  existing puppeteer + node setup, adding ~20s to the job.

- `scripts/pre-commit` runs the same check locally, but only when
  `examples/platformer.{ne,nes}`, `tests/emulator/record_gif.mjs`,
  or `tests/emulator/harness.html` is staged, and only if
  `tests/emulator/node_modules` is already installed. Cold-start
  puppeteer is ~20s — too slow to pay on every commit, but cheap
  enough to pay when something gif-relevant changed.

- The header of `tests/emulator/record_gif.mjs` and the project
  conventions section of `CLAUDE.md` both spell out the rerun
  command and the invariant, so the next agent doesn't have to
  re-derive any of this.

https://claude.ai/code/session_013Bi4H4YQ5or5HtMB4doUFi
This commit is contained in:
Claude 2026-04-13 18:04:17 +00:00
parent 629fdcfce0
commit 5e3e68ca11
No known key found for this signature in database
5 changed files with 65 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
scripts/pre-commit
View file

@ -39,4 +39,26 @@ if [ $stale -ne 0 ]; then
exit 1
fi
# Only rebuild docs/platformer.gif when platformer.nes or the gif
# recorder itself changed — the gif regeneration takes ~20s due to
# puppeteer's cold start, so we don't want to pay it on every commit.
# Skipped entirely if node_modules isn't installed in the emulator
# harness; the CI `emulator` job is the authoritative check.
changed_files=$(git diff --cached --name-only)
if echo "$changed_files" | grep -qE '^(examples/platformer\.(ne|nes)|tests/emulator/record_gif\.mjs|tests/emulator/harness\.html)$'; then
if [ -d tests/emulator/node_modules ]; then
echo " Rebuilding docs/platformer.gif (platformer.nes or recorder changed)..."
(cd tests/emulator && node record_gif.mjs platformer 360 2 /tmp/platformer-precheck.gif >/dev/null)
if ! cmp -s docs/platformer.gif /tmp/platformer-precheck.gif; then
echo " STALE: docs/platformer.gif"
echo " rerun: node tests/emulator/record_gif.mjs platformer 360 2 docs/platformer.gif"
rm -f /tmp/platformer-precheck.gif
exit 1
fi
rm -f /tmp/platformer-precheck.gif
else
echo " (skipping gif freshness check — tests/emulator/node_modules not installed)"
fi
fi
echo "All pre-commit checks passed."