Repository navigation
Ship agent docs with the packages, and check simulation lint coverage - #54
Merged
Merged
Conversation
…ulation lint coverage - Add the `ritmo` agent skill to @typeonce/ritmo (skills/ritmo/SKILL.md). - `ritmo-devtools lint` reports every module the simulation loads that the .oxlintrc.json simulation override does not cover (exit 1); Node >= 22.15. - Ship CHANGELOG.md in every package; move the 0.8/0.9 upgrade notes into the core changelog. MIGRATION.md keeps only the bevy-ts rename, which the published npm deprecation messages link to. - Fix shipped JSDoc (Command example, Random/time as services, inspector semantics), move the remaining CONCEPTS/GAME_API guidance into JSDoc, and prefix every example name. - Root README is the human doc, with agent setup; delete CONCEPTS.md, GAME_API.md, PLATFORM.md (folded into AGENTS.md), the example READMEs, and the superseded recipes example. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A game's coding agent only sees what npm installs. This PR makes that its complete source of truth, makes the root README the only doc for humans, and closes the fail-open gap in the simulation lint rules.
For game agents (all shipped in the packages)
SETUP.md(in@typeonce/ritmo): one-time setup. Base packages and checks for every game (ritmo,ritmo-math,ritmo-devtools,oxlint-plugin-ritmo,oxlint), add-ons only when needed (ritmo-browser,ritmo-render,ritmo-pixi), linking the skill,.oxlintrc.json, aritmo-devtools lintentry, and one check script.skills/ritmo/SKILL.md: for every change. Where the docs are (source JSDoc, READMEs, changelogs), principles for where code and state belong, and a self-check. It doesn't repeat anything JSDoc, READMEs or lint messages already say.CHANGELOG.md. The 0.8.0 and 0.9.0 upgrade notes moved into the core changelog.MIGRATION.mdkeeps only the bevy-ts rename, which the published npm deprecation messages link to.Commandexample compiles;Math.randomorperformance.now()as services;ritmo-devtools lint:uncovered-simulation-module.oxlintrc.jsondirectory and outsidenode_modules, whereritmo/keep-simulation-headlessis not on. Overrides apply in order, last match wins, andignorePatternscounts as uncovered. The command exits 1 when anything is reported.lintTarget, such as render schedules passed todescribe, are host code and not checked.extends, or no simulation override, it prints why the check didn't run and does not fail.engines.node).For humans
SETUP.md.Verification
pnpm run checkandpnpm pack:checkpass.pack:checknow asserts thatCHANGELOG.md,SETUP.mdand the skill are in the tarballs.Clock, seededRandom,InputCaptureandFixedLoop, wrote headless tests includingDeterminism.check, and passed their ownpnpm check.Follow-up
Running the new check against
examples/top-downfinds modules the repo's own.oxlintrc.jsondoesn't cover.🤖 Generated with Claude Code