Uh oh!
There was an error while loading. Please reload this page.
chore: add treefmt formatting (nix fmt + pre-commit + CI check) - #7
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 repository (treefmt via nix fmt), including developer ergonomics (pre-commit) and enforcement (CI), and applies the first formatting pass across PureScript and Lua FFI sources.
Changes:
- Add treefmt configuration (
treefmt.nix) and formatter configs for PureScript (.tidyrc.json) and Lua FFI (.lua-format). - Wire treefmt-nix into
flake.nixto providenix fmt, expose a formatting check, and install a pre-commit hook from the dev shell. - Add a CI “Format check” step and apply formatting-only edits across
.pursand.luafiles.
Reviewed changes
Copilot reviewed 17 out of 20 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| treefmt.nix | Defines treefmt programs and repository-wide excludes. |
| flake.nix | Adds treefmt-nix integration, nix fmt formatter output, formatting check, and devShell hook installation. |
| flake.lock | Pins treefmt-nix input. |
| .github/workflows/ci.yml | Adds formatting check step; updates luacheck max line length. |
| AGENTS.md | Documents lint/format commands and formatting rationale. |
| .tidyrc.json | Configures purs-tidy formatting. |
| .lua-format | Configures LuaFormatter formatting. |
| .gitignore | Ensures formatting config files are not ignored. |
| src/Data/Traversable.lua | LuaFormatter-driven formatting tweak. |
| src/Data/*.purs | purs-tidy-driven formatting across library modules. |
| test/*.purs | purs-tidy-driven formatting across tests. |
| test-regression/Main.purs | purs-tidy-driven formatting in regression tests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.