chore: add treefmt formatting (nix fmt + pre-commit + CI check)#4
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
Adds a standardized, Nix-native formatting setup to the repository using treefmt-nix, including local developer ergonomics (via nix fmt and a pre-commit hook) and an automated CI formatting check.
Changes:
- Introduce
treefmt.nixplus formatter configs (.tidyrc.json,.lua-format) and expose the flakeformatter+checks.formatting. - Add a dev-shell
shellHookto install a formatting pre-commit hook; document formatting workflow inAGENTS.md. - Add CI “Format check” step and apply an initial formatting pass across existing Dhall/PureScript/Lua sources.
Reviewed changes
Copilot reviewed 7 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
treefmt.nix |
Defines treefmt programs (nixfmt, dhall, purs-tidy, lua-format) and global excludes. |
flake.nix |
Wires treefmt-nix into the flake (formatter + check) and adds a pre-commit-installing shellHook. |
flake.lock |
Adds the treefmt-nix input pin. |
.github/workflows/ci.yml |
Adds a formatting check step; updates luacheck max line length. |
AGENTS.md |
Documents nix fmt usage and formatting rationale/constraints. |
.tidyrc.json |
purs-tidy configuration for PureScript formatting. |
.lua-format |
LuaFormatter configuration for FFI formatting. |
.gitignore |
Un-ignores .tidyrc.json and .lua-format so they can be committed. |
spago.dhall |
Dhall formatting normalization. |
test/Main.purs |
purs-tidy formatting pass. |
src/Unsafe/Coerce.purs |
Removes an extraneous leading line and normalizes formatting. |
💡 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.