chore: migrate flake to the purescript-overlay canon, add AGENTS.md#4
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Migrates the project’s Nix flake-based developer environment from easy-purescript-nix to the shared purescript-overlay canon, and adds standardized AI-agent instructions for consistent build/lint workflows across coding agents.
Changes:
- Update
flake.nix/flake.lockto usepurescript-overlayand pin the canonical PureScript + Spago + Lua 5.1 toolchain. - Add
AGENTS.md(andCLAUDE.mdimport) describing project constraints and common commands for coding agents. - Remove leftover JavaScript-era tooling files (
package.json,.eslintrc.json).
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Removes unused legacy JS build tooling metadata. |
| .eslintrc.json | Removes unused legacy ESLint configuration. |
| flake.nix | Switches dev shell to purescript-overlay canon and adds nixConfig cache settings. |
| flake.lock | Updates lockfile to reflect the overlay migration and refreshed inputs. |
| AGENTS.md | Adds agent-readable build/lint/toolchain + Lua 5.1 constraints documentation. |
| CLAUDE.md | Imports AGENTS.md so Claude Code reads the same instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
d4d3e47 to
859821e
Compare
Move the dev shell off easy-purescript-nix onto the shared purescript-overlay (purs 0.15.16, spago 0.21.0, lua51). Add AGENTS.md as the single agent instruction file + CLAUDE.md @-import. Drop dead JS-era files. Tooling and docs only.
859821e to
4446329
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.
Moves the dev shell to the shared
purescript-overlaycanon (purs 0.15.16, spago 0.21.0, Lua 5.1), off theeasy-purescript-nixsetup the rest of the forks have already left. The CI was brought onto the canon in #3, so this is the flake half plus the AI-agent instructions.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 also drops the dead
.eslintrc.jsonandpackage.jsonleft over from the JavaScript build.Tooling and docs only, no
src/change, so there is no tag or package-set bump.Verification
nix develop -c ./scripts/buildcompiles the fork on the overlay shell (writesdist/Effect_Console.lua) and luacheck with--std lua51 --no-unused-args src/is clean locally.