chore: add AGENTS.md, drop dead JavaScript-era files#5
Merged
Conversation
0491add to
93ff734
Compare
There was a problem hiding this comment.
Pull request overview
This PR performs repository housekeeping for the PureScript→Lua fork by adding agent-facing developer instructions and removing legacy JavaScript-era build metadata that’s no longer used with the current nix+spago toolchain.
Changes:
- Add
AGENTS.mddocumenting build/test/lint commands, Lua 5.1 constraints, and the Lua FFI parenthesization rule. - Add
CLAUDE.mdto reuseAGENTS.mdfor Claude Code via an@AGENTS.mdimport. - Remove obsolete
package.jsonandbower.jsonfrom the prior JS/pulp workflow.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| package.json | Removed legacy Node/pulp-era scripts and devDependencies. |
| bower.json | Removed legacy Bower-era package metadata. |
| AGENTS.md | Added canonical agent instructions for nix/spago/pslua, Lua 5.1 constraints, and FFI parsing rules. |
| CLAUDE.md | Added a single-line import to ensure Claude Code reads AGENTS.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
e3f0a7d to
3afcb55
Compare
AGENTS.md is the single instruction file the coding agents read natively; CLAUDE.md is a one-line @AGENTS.md import so Claude Code shares it. Also removes dead bower.json/package.json/.eslintrc.json. CI is already on the shared canon; no src/ change.
3afcb55 to
66c3222
Compare
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.
This fork's CI is already on the shared canon, so this is docs and cleanup only: it adds the AI-agent instructions and clears out the dead JavaScript-era files.
AGENTS.md+CLAUDE.md:AGENTS.mdis the one instruction file the coding agents read natively (Codex, Cursor, Copilot, Gemini CLI, Aider): the build/test/lint commands, the Lua 5.1 constraints, the FFI parenthesisation rule, and the toolchain pins.CLAUDE.mdis a one-line@AGENTS.mdimport so Claude Code reads the same file instead of a second copy that drifts out of sync.It drops
bower.json,package.jsonleft over from the JavaScript build; the toolchain is spago plus nix now.No
src/change, so there is no tag or package-set bump.Verification
nix develop -c ./scripts/build, the regression suite, and luacheck are clean locally.