1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-06-25 14:51:16 +02:00

Update nix fmt man page with official formatter example

The current example relies upon [nixfmt's deprecated tree traversal
behavior](https://github.com/NixOS/nixfmt/pull/240). The simplest
alternative is the new `nixfmt-tree` wrapper for `nixfmt`/`treefmt`.
This commit is contained in:
Jeremy Fleischman 2025-04-13 11:30:18 -07:00 committed by Jörg Thalheim
parent 143fb88ceb
commit 6f71d8a9c2

View file

@ -9,37 +9,15 @@ Flags can be forwarded to the formatter by using `--` followed by the flags.
Any arguments will be forwarded to the formatter. Typically these are the files to format. Any arguments will be forwarded to the formatter. Typically these are the files to format.
# Examples # Example
With [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt): To use the [official Nix formatter](https://github.com/NixOS/nixfmt):
```nix ```nix
# flake.nix # flake.nix
{ {
outputs = { nixpkgs, self }: { outputs = { nixpkgs, self }: {
formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.nixpkgs-fmt; formatter.x86_64-linux = nixpkgs.legacyPackages.${system}.nixfmt-tree;
};
}
```
With [nixfmt](https://github.com/NixOS/nixfmt):
```nix
# flake.nix
{
outputs = { nixpkgs, self }: {
formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.nixfmt-rfc-style;
};
}
```
With [Alejandra](https://github.com/kamadorueda/alejandra):
```nix
# flake.nix
{
outputs = { nixpkgs, self }: {
formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.alejandra;
}; };
} }
``` ```