mirror of
https://github.com/bryanthaboi/gen1recomp.git
synced 2026-08-12 16:31:05 +02:00
74eeb411ba
Introduce a tuned .luacheckrc and scripts/lint.sh so the engine has a standing static-analysis baseline -- the tool that would have caught both bugs in the previous commit before they shipped. The config is high-signal by design: it keeps the categories that catch real defects (undefined globals/locals, unused values, unreachable code) and mutes the cosmetic ones the codebase deliberately lives with (a self/dt an interface requires but a method ignores, documented empty fall-through branches, long lines). It marks `love` mutable (games assign callbacks onto it) and teaches it LuaJIT's table.unpack. .luacheckrc is tracked via a .gitignore exception, matching how .github and .gitignore opt out of the blanket dotfile ignore. `luacheck src` now reports 7 benign warnings and 0 errors, down from 185. Also drop one dead `require` (ItemEffects loaded src.pokemon.Pokemon and never used it). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q6bFAiQyZ5jDmewsbB4LG9
24 lines
812 B
Bash
Executable File
24 lines
812 B
Bash
Executable File
#!/usr/bin/env bash
|
|
# Static analysis for the engine Lua (config: .luacheckrc).
|
|
#
|
|
# Complements scripts/test.sh: the tests prove behavior, luacheck catches the
|
|
# defects that never run in a green test -- undefined globals/locals (the
|
|
# class that hid a music.volume crash: a hook read a `state` that was still
|
|
# the nil global), unused values, unreachable code. The .luacheckrc mutes the
|
|
# cosmetic categories the codebase lives with, so what prints is worth a look.
|
|
#
|
|
# scripts/lint.sh lint src/
|
|
# scripts/lint.sh src tools lint specific paths
|
|
#
|
|
# Install once with: luarocks install luacheck
|
|
|
|
set -uo pipefail
|
|
cd "$(dirname "$0")/.."
|
|
|
|
if ! command -v luacheck >/dev/null 2>&1; then
|
|
echo "luacheck not found on PATH (install: luarocks install luacheck)" >&2
|
|
exit 2
|
|
fi
|
|
|
|
luacheck "${@:-src}"
|