mirror of
https://github.com/NixOS/nix.git
synced 2024-11-25 00:02:25 +00:00
doc/nix fmt: Do not document behavior we do not control
This leads to confusion about what the command does. E.g. https://github.com/NixOS/nix/issues/9359 - Move the description up - Remove details about the individual formatters
This commit is contained in:
parent
ca3fc1693b
commit
8c4842de8c
@ -1,5 +1,14 @@
|
||||
R""(
|
||||
|
||||
# Description
|
||||
|
||||
`nix fmt` calls the formatter specified in the flake.
|
||||
|
||||
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
|
||||
|
||||
With [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt):
|
||||
@ -13,10 +22,6 @@ With [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt):
|
||||
}
|
||||
```
|
||||
|
||||
- Format the current flake: `$ nix fmt`
|
||||
|
||||
- Format a specific folder or file: `$ nix fmt ./folder ./file.nix`
|
||||
|
||||
With [nixfmt](https://github.com/serokell/nixfmt):
|
||||
|
||||
```nix
|
||||
@ -28,8 +33,6 @@ With [nixfmt](https://github.com/serokell/nixfmt):
|
||||
}
|
||||
```
|
||||
|
||||
- Format specific files: `$ nix fmt ./file1.nix ./file2.nix`
|
||||
|
||||
With [Alejandra](https://github.com/kamadorueda/alejandra):
|
||||
|
||||
```nix
|
||||
@ -41,13 +44,4 @@ With [Alejandra](https://github.com/kamadorueda/alejandra):
|
||||
}
|
||||
```
|
||||
|
||||
- Format the current flake: `$ nix fmt`
|
||||
|
||||
- Format a specific folder or file: `$ nix fmt ./folder ./file.nix`
|
||||
|
||||
# Description
|
||||
|
||||
`nix fmt` will rewrite all Nix files (\*.nix) to a canonical format
|
||||
using the formatter specified in your flake.
|
||||
|
||||
)""
|
||||
|
@ -11,7 +11,7 @@ cp ./simple.nix ./simple.builder.sh ./fmt.simple.sh ./config.nix "$TEST_HOME"
|
||||
|
||||
cd "$TEST_HOME"
|
||||
|
||||
nix fmt --help | grep "Format"
|
||||
nix fmt --help | grep "forward"
|
||||
|
||||
cat << EOF > flake.nix
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user