chore: add treefmt formatting (nix fmt + pre-commit + CI check)#6
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 a standardized formatting workflow (treefmt via treefmt-nix) so contributors can run nix fmt, get a pre-commit formatting check, and have CI enforce formatting, alongside a first formatting pass over existing sources.
Changes:
- Add treefmt-nix integration to the flake (
nix fmt,checks.formatting, dev-shell pre-commit hook). - Add formatter configurations for PureScript (purs-tidy) and Lua FFI (LuaFormatter), plus docs updates.
- Apply formatting updates across existing
*.pursand Dhall config, and add a CI formatting check step.
Reviewed changes
Copilot reviewed 9 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| treefmt.nix | Defines treefmt configuration (nixfmt, dhall, purs-tidy, lua-format) and global excludes. |
| flake.nix | Wires in treefmt-nix, exposes formatter/check, and installs a pre-commit formatting hook in the dev shell. |
| flake.lock | Adds the treefmt-nix input lock. |
| .github/workflows/ci.yml | Adds a formatting check step; updates luacheck line-length. |
| .tidyrc.json | Adds purs-tidy configuration used by formatting. |
| .lua-format | Adds LuaFormatter configuration for src/ FFI code. |
| .gitignore | Ensures .tidyrc.json and .lua-format aren’t ignored by the existing dotfile ignore rule. |
| AGENTS.md | Documents lint/format commands and the rationale for the formatting approach. |
| spago.dhall | Applies dhall format output changes. |
| src/Data/Int.purs | Formatting-only changes to PureScript source. |
| src/Data/Int/Bits.purs | Formatting-only changes to export list layout. |
| test/Test/Data/Int.purs | Formatting-only changes to test code layout. |
💡 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.