Skip to content

chore: migrate flake to the purescript-overlay canon, add AGENTS.md - #4

Merged
Unisay merged 1 commit into
masterfrom
chore/agents-md-and-canon-ci
Jun 14, 2026
Merged

chore: migrate flake to the purescript-overlay canon, add AGENTS.md#4
Unisay merged 1 commit into
masterfrom
chore/agents-md-and-canon-ci

Conversation

@Unisay

Copy link
Copy Markdown
Collaborator

Moves the dev shell to the shared purescript-overlay canon (purs 0.15.16, spago 0.21.0, Lua 5.1), off the easy-purescript-nix setup 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.md is 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.md is a one-line @AGENTS.md import so Claude Code reads the same file instead of a second copy that drifts out of sync.

It also drops the dead .eslintrc.json and package.json left 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/build compiles the fork on the overlay shell (writes dist/Effect_Console.lua) and luacheck with --std lua51 --no-unused-args src/ is clean locally.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.lock to use purescript-overlay and pin the canonical PureScript + Spago + Lua 5.1 toolchain.
  • Add AGENTS.md (and CLAUDE.md import) 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
FileDescription
package.jsonRemoves unused legacy JS build tooling metadata.
.eslintrc.jsonRemoves unused legacy ESLint configuration.
flake.nixSwitches dev shell to purescript-overlay canon and adds nixConfig cache settings.
flake.lockUpdates lockfile to reflect the overlay migration and refreshed inputs.
AGENTS.mdAdds agent-readable build/lint/toolchain + Lua 5.1 constraints documentation.
CLAUDE.mdImports AGENTS.md so Claude Code reads the same instructions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threadAGENTS.md
Comment threadAGENTS.md Outdated
@Unisay
Unisayforce-pushed the chore/agents-md-and-canon-ci branch 3 times, most recently from d4d3e47 to 859821eCompareJune 14, 2026 17:11
@Unisay
Unisay marked this pull request as ready for review June 14, 2026 17:12
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.
@Unisay
Unisayforce-pushed the chore/agents-md-and-canon-ci branch from 859821e to 4446329CompareJune 14, 2026 17:18
@Unisay
Unisay merged commit 3b1b1ec into masterJun 14, 2026
1 check passed
@Unisay
Unisay deleted the chore/agents-md-and-canon-ci branch June 14, 2026 17:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@Unisay