Implement style check script and CI by itsgrimetime · Pull Request #2670 · doldecomp/melee

itsgrimetime · 2026-06-12T21:13:14Z

Summary

Tooling for the style-check series. Both source sweeps merged separately (#2675 jobj 0x10→JOBJ_HIDDEN, #2676 assert macros), so this PR is tooling only.

Adds tools/check/ — a small, extensible style checker:

two checks, both enabled by default and disabled with --no-<check> (mirrors clang -Wno-): jobj-flags (raw 0x10 where JOBJ_HIDDEN is meant) and assert-macros (direct __assert calls expressible with the HSD assert macros; @todo-annotated sites exempt)
--msg-style std (default) mirrors melee-issues (tools/issues): a severity > category > [option] > file hierarchy and an Issues: OK / Issues: N summary, with the same exit codes (0 / 65 EX_DATAERR / 74 EX_IOERR). --msg-style actions emits GitHub Actions annotations.
comment/string-aware scanning that handles calls split across lines
fixtures per check under tools/check/tests/ (run: python3 -m unittest discover -s tools/check/tests -t tools -p '*.py')

CI (style-check.yml) lints src on push and pull_request — findings fail the job with inline annotations, mirroring melee-issues. The unit tests are a development tool and are not run in CI.

Incorporates @ribbanya's review (module layout; opt-out per-check flags; --msg-style; std mirrors melee-issues + exit codes; type annotations; line-break handling; precompiled regex; tests as a separate module; lint src in CI, not the unit tests).

🤖 Generated with Claude Code

decomp-dev · 2026-06-12T21:17:37Z

Report for GALE01 (`3a7df8e` - `5896c57`)

No changes

Scans all of src/ at the PR merge ref and warns (non-blocking, inline file/line annotations) on any HSD_JObj{Set,Clear}Flags[All] call passing raw 0x10/0x10U/16 instead of JOBJ_HIDDEN. The scanner is comment- and string-literal-aware and paren-walks calls, so wrapped/multi-line calls are detected; since doldecomp#2670 sweeps the tree to zero, any finding is newly introduced. The workflow only reads source text and never executes PR-controlled code. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

itsgrimetime · 2026-06-12T21:48:42Z

~~actually gonna move it into the issues checker/repo tools script as @ribbanya suggested in discord~~
Actually just a separate python script because editing a script sitting inline in yaml sucks

Syntax-aware sweep of HSD_JObj{Set,Clear}Flags[All] call sites replacing raw hidden-flag literals (0x10 / 0x10U / 16 / 16U) in the flag argument with the named JOBJ_HIDDEN: 505 sites across 73 files. Composite masks and other flag values are untouched. All 1046 compiled objects verified byte-identical before and after the change (per-object sha1); main.dol sha1 unchanged. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

A small, extensible style checker for the source tree. Each check is enabled by default and can be disabled with --no-<check> (mirroring clang's -Wno- flags); --msg-style {std,actions} selects human-readable or GitHub Actions annotation output (mirroring configure.py and mwcc). The first check, jobj-flags, flags HSD_JObj{Set,Clear}Flags[All] calls passing a raw hidden-flag literal instead of JOBJ_HIDDEN. The flag argument is matched with a precompiled regex covering the integer forms whose value is 16 (hex/decimal/octal, optional suffix); the call scanner is comment- and string-aware and handles calls split across lines. tools/test_check.py holds the fixtures (run: python3 tools/test_check.py). The style-check workflow runs the tests, then the checker over src/ as non-blocking inline warnings. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Move the single-file checker into a package: tools/check/main.py (the driver and checks) and tools/check/__init__.py, with per-check fixtures under tools/check/tests/. Both checks (jobj-flags, assert-macros) live in the module; each is enabled by default and disabled with --no-<check>. std output now mirrors melee-issues (tools/issues): a severity > category > [option] > file hierarchy and a final Issues: OK / Issues: N summary, with matching exit codes (0, 65 EX_DATAERR, 74 EX_IOERR). --msg-style actions still emits GitHub Actions annotations. Remove the style-check CI workflow; the checker is a development tool run on demand (python3 tools/check/main.py), not part of CI. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

ribbanya

Did the CI check get lost?

itsgrimetime · 2026-06-13T19:07:27Z

Both checks are already in — tools/check/main.py registers jobj-flags and assert-macros, with fixtures in tools/check/tests/jobj_flags.py and tools/check/tests/assert_macros.py. Folded the #2671 check in during the restructure, so this should be ready to merge?

Or maybe I misunderstood what you meant by "Remove the CI check, it's for development of the tool only."

ribbanya · 2026-06-13T19:07:29Z

Oh I see, the bot interpreted "don't run the self-tests during CI" as "remove the source checks from CI." It should definitely be linting src on pull requests. Just not the unit tests.

itsgrimetime · 2026-06-13T19:08:36Z

Oh I see, the bot interpreted "don't run the self-tests during CI" as "remove the source checks from CI." It should definitely be linting src on pull requests. Just not the unit tests.

Ah gotchya - that was misunderstanding on both claude & I's part lol

Run the checker over src on push and pull_request. Findings fail the job (exit 65) with inline annotations (--msg-style actions); an internal error fails it (74). The unit tests under tools/check/tests are a development tool and are intentionally not run in CI. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

itsgrimetime · 2026-06-13T19:16:24Z

okay should be good now? lmk if you want anything else adjusted

ribbanya · 2026-06-13T19:25:10Z

It would be useful to also have a CLI option that applies the fixes (to be run locally), instead of relying on an LLM to interpret and implement them. But that can be done later, or never, up to you.

itsgrimetime · 2026-06-13T22:59:32Z

It would be useful to also have a CLI option that applies the fixes (to be run locally), instead of relying on an LLM to interpret and implement them. But that can be done later, or never, up to you.

love that idea - im gonna be continuing to do some tooling improvements like this so will fold that in in some upcoming PRs. thanks for the help on this one

itsgrimetime marked this pull request as draft June 12, 2026 21:13

itsgrimetime force-pushed the pr/jobj-hidden-sweep branch from 937c247 to d9abccf Compare June 12, 2026 21:24

itsgrimetime force-pushed the pr/jobj-hidden-sweep branch from d9abccf to e97b985 Compare June 12, 2026 21:50

itsgrimetime marked this pull request as ready for review June 12, 2026 21:56

itsgrimetime mentioned this pull request Jun 12, 2026

Use HSD assert macros for hand-expanded asserts #2671

Closed

ribbanya requested changes Jun 12, 2026

View reviewed changes

Comment thread tools/jobj_flags_check.py Outdated

itsgrimetime and others added 2 commits June 12, 2026 20:59

itsgrimetime force-pushed the pr/jobj-hidden-sweep branch from e97b985 to d1e7417 Compare June 13, 2026 04:00

ribbanya mentioned this pull request Jun 13, 2026

Replace raw 0x10 with JOBJ_HIDDEN in HSD_JObj flag calls #2675

Merged

Merge branch 'upstream-master' into pr/jobj-hidden-sweep

035d0aa

ribbanya changed the title ~~Replace raw 0x10 with JOBJ_HIDDEN in JObj flag calls~~ Implement style check script and CI Jun 13, 2026

ribbanya and others added 3 commits June 13, 2026 14:44

Merge branch 'master' into pr/jobj-hidden-sweep

df00395

Merge branch 'master' into pr/jobj-hidden-sweep

d852fc4

ribbanya requested changes Jun 13, 2026

View reviewed changes

Comment thread tools/check/main.py

ribbanya approved these changes Jun 13, 2026

View reviewed changes

ribbanya added tooling code-quality labels Jun 13, 2026

ribbanya requested changes Jun 13, 2026

View reviewed changes

Comment thread .github/workflows/style-check.yml Outdated

Comment thread .github/workflows/style-check.yml Outdated

Comment thread .github/workflows/style-check.yml Outdated

ribbanya requested changes Jun 13, 2026

View reviewed changes

Comment thread .github/workflows/style-check.yml Outdated

Rename and clean up CI workflow

dcae43a

ribbanya force-pushed the pr/jobj-hidden-sweep branch from 5896c57 to dcae43a Compare June 13, 2026 21:23

Include the script and workflow in trigger

1e12fc0

ribbanya approved these changes Jun 13, 2026

View reviewed changes

ribbanya enabled auto-merge (squash) June 13, 2026 21:28

ribbanya merged commit 65cdc5f into doldecomp:master Jun 13, 2026
11 checks passed

itsgrimetime mentioned this pull request Jun 14, 2026

Tracking: tools/check style-check roadmap #2693

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement style check script and CI#2670

Implement style check script and CI#2670
ribbanya merged 9 commits into
doldecomp:masterfrom
itsgrimetime:pr/jobj-hidden-sweep

itsgrimetime commented Jun 12, 2026 •

edited

Loading

Uh oh!

decomp-dev Bot commented Jun 12, 2026 •

edited

Loading

Uh oh!

itsgrimetime commented Jun 12, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

ribbanya left a comment

Uh oh!

itsgrimetime commented Jun 13, 2026

Uh oh!

ribbanya commented Jun 13, 2026 •

edited

Loading

Uh oh!

itsgrimetime commented Jun 13, 2026

Uh oh!

itsgrimetime commented Jun 13, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ribbanya commented Jun 13, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

itsgrimetime commented Jun 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

itsgrimetime commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

decomp-dev Bot commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Report for GALE01 (3a7df8e - 5896c57)

Uh oh!

itsgrimetime commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ribbanya left a comment

Choose a reason for hiding this comment

Uh oh!

itsgrimetime commented Jun 13, 2026

Uh oh!

ribbanya commented Jun 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

itsgrimetime commented Jun 13, 2026

Uh oh!

itsgrimetime commented Jun 13, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ribbanya commented Jun 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

itsgrimetime commented Jun 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

itsgrimetime commented Jun 12, 2026 •

edited

Loading

decomp-dev Bot commented Jun 12, 2026 •

edited

Loading

Report for GALE01 (`3a7df8e` - `5896c57`)

itsgrimetime commented Jun 12, 2026 •

edited

Loading

ribbanya commented Jun 13, 2026 •

edited

Loading

ribbanya commented Jun 13, 2026 •

edited

Loading