chore: add treefmt formatting (nix fmt + pre-commit + CI check)#2
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 introduces repo-wide, Nix-flake-integrated formatting via treefmt (exposed as nix fmt), along with a CI format check and a dev-shell-installed pre-commit hook, and applies the first formatting pass across PureScript and Lua FFI sources.
Changes:
- Add
treefmt-nixintegration inflake.nix(formatter +checks.formatting) and add a CI “Format check” step. - Add treefmt configuration (
treefmt.nix) plus formatter configs for purs-tidy and LuaFormatter (.tidyrc.json,.lua-format), and update docs/ignore rules accordingly. - Apply formatting updates across existing
*.purssources, Lua FFI, regression tests, and benchmarks; align luacheck line-length budget to 130.
Reviewed changes
Copilot reviewed 17 out of 22 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
treefmt.nix |
Defines treefmt programs for Nix/Dhall/PureScript/Lua and global excludes. |
flake.nix |
Wires treefmt-nix into the flake, exposes formatter/check, and installs a pre-commit hook in the dev shell. |
flake.lock |
Adds the treefmt-nix flake input lock entry. |
.github/workflows/ci.yml |
Adds --max-line-length 130 to luacheck and introduces a format-check step. |
AGENTS.md |
Documents formatting commands and rationale (treefmt + LuaFormatter parentheses requirement). |
.tidyrc.json |
Adds purs-tidy configuration used by treefmt. |
.lua-format |
Adds LuaFormatter configuration for Lua FFI formatting constraints. |
.gitignore |
Ensures new formatter config dotfiles are not ignored. |
src/Data/Array.purs |
Formatting-only changes (line wraps/indentation). |
src/Data/Array.lua |
Formatting-only changes to Lua FFI code style. |
src/Data/Array/NonEmpty.purs |
Formatting-only changes (exports, type signatures, layout). |
src/Data/Array/NonEmpty/Internal.purs |
Formatting-only changes to derived instance declarations. |
src/Data/Array/ST.purs |
Formatting-only changes to foreign import type formatting. |
src/Data/Array/ST/Iterator.purs |
Formatting-only changes to type signature layout. |
bench/Data/Array.purs |
Formatting-only changes to let layout. |
test/regression/array_st.lua |
Formatting-only changes to Lua regression test formatting. |
test/Test/Data/UndefinedOr.purs |
Formatting-only changes to foreign import type layout. |
test/Test/Data/Array/ST/Partial.purs |
Formatting-only changes (array literal spacing). |
test/Test/Data/Array/ST.purs |
Formatting-only changes (wrapping/indentation). |
test/Test/Data/Array/Partial.purs |
Formatting-only changes (array literal spacing). |
test/Test/Data/Array/NonEmpty.purs |
Formatting-only changes (wrapping/indentation). |
test/Test/Data/Array.purs |
Formatting-only changes (wrapping/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 + regression test +luacheck --max-line-length 130green.