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 nginx FFI keeps its `--globals ngx` luacheck flag. Replaces the bespoke .lua-format with the ecosystem canon (compact one-liners).
There was a problem hiding this comment.
Pull request overview
This PR rolls out standardized formatting infrastructure (treefmt-nix + nix fmt), including a pre-commit hook and a CI formatting check, aligning this fork with the upstream ecosystem formatting setup.
Changes:
- Adds treefmt-nix integration to the flake (
formatteroutput +checks.formatting) and documents formatting usage. - Introduces formatting configs for PureScript (
.tidyrc.json) and Lua FFI (.lua-format) and normalizes Dhall formatting. - Updates CI to run a content-based formatting check (
nix fmt && git diff --exit-code) alongside existing build/lint steps.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
treefmt.nix |
Defines the treefmt-nix formatting module (nixfmt, dhall, purs-tidy, lua-format, excludes). |
flake.nix |
Wires treefmt-nix into the flake outputs and adds a devShell hook to install a pre-commit formatter check. |
.github/workflows/ci.yml |
Adds a formatting check step and updates luacheck flags. |
.tidyrc.json |
Adds purs-tidy configuration for formatting PureScript sources. |
.lua-format |
Replaces LuaFormatter config with the ecosystem canonical settings and updated line budget. |
AGENTS.md |
Documents formatting workflow (nix fmt + diff-based check) and updates lint command. |
packages.dhall |
Normalizes formatting output (removes trailing whitespace line). |
flake.lock |
Adds the treefmt-nix input pin. |
💡 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.Fork specifics. Replaces the fork's bespoke
.lua-formatwith the ecosystem canon (compact one-liners); the nginx FFI keeps itsluacheck --globals ngxflag, with--max-line-lengthraised to 130.dhall formatalso normalisedpackages.dhall. Verified locally: build +luacheck --globals ngx --max-line-length 130green.