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

Merge pull request #13124 from NixOS/mergify/bp/2.28-maintenance/pr-13014

Update `nix fmt` man page with official formatter example (backport #13014)
This commit is contained in:
mergify[bot] 2025-05-01 13:45:45 +00:00 committed by GitHub
commit 8de4c272dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

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.
# Examples
# Example
With [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt):
To use the [official Nix formatter](https://github.com/NixOS/nixfmt):
```nix
# flake.nix
{
outputs = { nixpkgs, self }: {
formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.nixpkgs-fmt;
};
}
```
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;
formatter.x86_64-linux = nixpkgs.legacyPackages.${system}.nixfmt-tree;
};
}
```