mirror of
https://github.com/imjasonh/nescript
synced 2026-07-09 17:28:00 +00:00
5e3e68ca11
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
64 lines
2.5 KiB
Bash
Executable file
64 lines
2.5 KiB
Bash
Executable file
#!/bin/sh
|
|
# Pre-commit hook for nescript
|
|
# Install: cp scripts/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit
|
|
|
|
set -e
|
|
|
|
echo "Running pre-commit checks..."
|
|
|
|
echo " Checking formatting..."
|
|
cargo fmt --all -- --check
|
|
|
|
echo " Running clippy..."
|
|
cargo clippy --all-targets -- -D warnings
|
|
|
|
echo " Running tests..."
|
|
cargo test --all-targets
|
|
|
|
# Committed ROMs must match their .ne sources — the compiler is
|
|
# deterministic, so any example whose on-disk .nes differs from a
|
|
# fresh build means someone edited the .ne file but forgot to
|
|
# rebuild. Rebuild each to a tmp path and fail if any differ, then
|
|
# point the user at the exact `cargo run` command to fix it.
|
|
echo " Checking committed ROMs match .ne sources..."
|
|
cargo build --release --quiet
|
|
tmp=$(mktemp -d)
|
|
trap 'rm -rf "$tmp"' EXIT
|
|
stale=0
|
|
for f in examples/*.ne; do
|
|
name=$(basename "$f" .ne)
|
|
./target/release/nescript build "$f" --output "$tmp/$name.nes" >/dev/null
|
|
if ! cmp -s "examples/$name.nes" "$tmp/$name.nes"; then
|
|
echo " STALE: examples/$name.nes"
|
|
echo " rerun: cargo run --release -- build $f"
|
|
stale=1
|
|
fi
|
|
done
|
|
if [ $stale -ne 0 ]; then
|
|
echo "one or more committed ROMs are out of date"
|
|
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."
|