chore: add treefmt formatting (nix fmt + pre-commit + CI check)#5
Merged
Conversation
Wire treefmt via treefmt-nix: nixfmt, dhall format, purs-tidy (.tidyrc.json) and LuaFormatter for the FFI (.lua-format, kept over StyLua because it preserves the parentheses pslua's parser needs). `nix fmt` formats; the dev shell installs a content-based pre-commit hook and CI runs `nix fmt && git diff --exit-code` (content-based, since the in-place formatters bump mtime and would trip treefmt --fail-on-change). Lua lines budget 130 cols, matching the raised `luacheck --max-line-length`. The bulk of the diff is the first format pass.
There was a problem hiding this comment.
Pull request overview
This PR rolls out a standardized formatting workflow for the repo using treefmt-nix, wiring it into the flake (nix fmt), adding a formatting check to CI, and introducing formatter configuration for PureScript and Lua (plus a first formatting pass over affected files).
Changes:
- Add
treefmt.nixplus formatter configs (.tidyrc.json,.lua-format) and exposeformatter+checks.formattingfrom the flake. - Install a pre-commit hook from the nix dev shell and add a CI “Format check” step (
nix fmt && git diff --exit-code). - Reformat touched
*.pursand*.luasources/tests to match the new tooling.
Reviewed changes
Copilot reviewed 12 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| treefmt.nix | Defines treefmt-nix configuration (nixfmt, dhall, purs-tidy, lua-format, excludes). |
| flake.nix | Adds treefmt-nix input, exposes formatter/checks.formatting, and installs a pre-commit hook in shellHook. |
| flake.lock | Locks the new treefmt-nix input. |
| .tidyrc.json | purs-tidy formatting configuration for *.purs. |
| .lua-format | LuaFormatter configuration used by treefmt for Lua sources. |
| .gitignore | Ensures the new formatter config dotfiles are tracked. |
| .github/workflows/ci.yml | Adds --max-line-length 130 to luacheck and a format-check step. |
| AGENTS.md | Documents updated lint/format commands and rationale. |
| src/Control/Lazy.purs | purs-tidy formatting pass (currently introduces a where layout issue). |
| src/Control/Alt.purs | Formatting-only changes. |
| src/Control/Plus.purs | Formatting-only changes. |
| src/Control/Comonad.purs | Formatting-only changes. |
| src/Control/Extend.purs | Formatting-only changes (exports + type signature wrapping). |
| src/Data/Monoid/Alternate.purs | Formatting-only changes (instance constraints wrapped). |
| src/Control/Extend.lua | LuaFormatter formatting pass (loop condensed). |
| test/regression/extend.lua | LuaFormatter formatting pass (spacing/indentation). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Roll the ecosystem formatting setup (ADR 0007, piloted in purescript-lua/purescript-lua-effect#6) onto this fork.
Tooling. Copies
treefmt.nix/.tidyrc.json/.lua-formatand wires treefmt-nix into the flake:nix fmtformats,checks.formattingis exposed, the dev shell installs a content-based pre-commit hook, and CI gains a format-check step. The check is content-based (nix fmt && git diff --exit-code) rather thantreefmt --ci, since the in-place formatters bump mtime even when content is unchanged. LuaFormatter is kept over StyLua because it preserves the parentheses pslua's foreign-file parser requires;luacheck --max-line-lengthraised to 130 to match.Diff. The bulk is the first
nix fmtpass over*.pursand the*.luaFFI. Verified locally: build +luacheck --max-line-length 130green + regression test.