nixfmt-tree: refactor impl to use treefmt.withConfig
#391319
Open
+73
−34
Conversation
This file contains 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
Refactor the new `nixfmt-tree` package, to make use of the new `treefmt.withConfig` wrapper. Breaking changes: 1. Overriding `settings` will no longer entirely replace all settings, instead settings are now merged as modules. 2. Adding the package to a nix shell will no longer make runtime inputs (such as `nixfmt`) available on the PATH, only the wrapped `treefmt` will be added to the shell's PATH. Non-breaking changes: 1. `runtimePackages` was renamed to `runtimeInputs`. For consistency with `treefmt.withConfig` and other parts of nixpkgs, such as `writeShellApplication`. 2. Added a warning when `runtimeInputs` is overridden to a list without a nixfmt package. In such cases, users should probably just use `treefmt.withConfig`.
nix-owners
bot
requested review from
jfly,
dasJ,
piegamesde,
0x4A6F and
infinisil
infinisil
approved these changes
Mar 19, 2025
| @@ -62,7 +80,7 @@ buildEnv { | |||
| ``` | |||
|
|
|||
| You can then also use `treefmt` in a pre-commit/pre-push [Git hook](https://git-scm.com/docs/githooks) | |||
| and `nixfmt` with your editors format-on-save feature. | |||
| and with your editor's format-on-save feature. | |||
There was a problem hiding this comment.
Yeah so this was the original motivation for including the formatter binaries as well, but as explained in the last formatting team meeting, people should be using treefmt even for format-on-save, because treefmt knows about the options you format the codebase with :)
wegank
added
12.approved-by: package-maintainer
|
Any objections to getting this merged @NixOS/nix-formatting ? |
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.
Follow up to #390147 and #384857, this PR refactors the new
nixfmt-treepackage to make use of the newtreefmt.withConfigwrapper.This is technically a breaking change:
settingswill no longer entirely replace all settings,instead settings are now merged as modules.
nixfmt) available on the PATH,only the wrapped
treefmtwill be added to the shell's PATH.There are also non-breaking changes:
runtimePackageswas renamed toruntimeInputs. For consistency withtreefmt.withConfigand other parts of nixpkgs, such aswriteShellApplication.runtimeInputsis overridden to a list without a nixfmt package. In such cases, users should probably just usetreefmt.withConfig.We could have it so that runtime inputs still end up being installed to
$out/bin/, but this would negate much of the advantage of delegating most impl-details totreefmt.withConfig. In hindsight, it also feels like a bit of a leaky abstraction?cc @infinisil @NixOS/nix-formatting
Things done
nix.conf? (See Nix manual)sandbox = relaxedsandbox = truenix-build -A nixfmt-tree.testsnix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)Add a 👍 reaction to pull requests you find important.