Skip to content

chore: add treefmt formatting (nix fmt + pre-commit + CI check) - #6

Merged
Unisay merged 1 commit into
masterfrom
chore/treefmt
Jun 15, 2026
Merged

chore: add treefmt formatting (nix fmt + pre-commit + CI check)#6
Unisay merged 1 commit into
masterfrom
chore/treefmt

Conversation

@Unisay

Copy link
Copy Markdown
Collaborator

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-format and wires treefmt-nix into the flake: nix fmt formats, checks.formatting is 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 than treefmt --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-length raised to 130 to match.

Diff. The bulk is the first nix fmt pass over *.purs and the *.lua FFI. Verified locally: build + luacheck --max-line-length 130 green.

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.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR rolls out repository-wide formatting support using treefmt-nix, wiring it into the flake so nix fmt works locally, CI enforces formatting, and the dev shell installs a pre-commit hook to prevent unformatted commits.

Changes:

  • Add treefmt-nix integration to flake.nix (formatter output + checks.formatting) and a dev-shell pre-commit hook.
  • Add formatter configs (treefmt.nix, .tidyrc.json, .lua-format) and document usage in AGENTS.md.
  • Update CI to run a format check and apply the initial formatter pass to PureScript/Lua sources.

Reviewed changes

Copilot reviewed 8 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
FileDescription
treefmt.nixDefines treefmt programs and custom formatters (purs-tidy, LuaFormatter) plus global excludes.
flake.nixAdds treefmt-nix input, exposes formatter/checks.formatting, installs a pre-commit hook in shellHook.
.github/workflows/ci.ymlAdds nix fmt && git diff --exit-code format check step; updates luacheck line length.
AGENTS.mdDocuments new format command and updated luacheck settings.
.tidyrc.jsonAdds purs-tidy configuration.
.lua-formatAdds LuaFormatter configuration for FFI sources.
.gitignoreEnsures new dotfile configs are tracked.
src/Test/Assert.pursPure formatting changes from purs-tidy.
src/Test/Assert.luaPure formatting changes from LuaFormatter.
flake.lockLocks the new treefmt-nix input.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threadtreefmt.nix
Comment threadtreefmt.nix
Comment threadflake.nix
@Unisay
Unisay merged commit 8498c10 into masterJun 15, 2026
2 checks passed
@Unisay
Unisay deleted the chore/treefmt branch June 15, 2026 08:08
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@Unisay