Skip to content

Commit

Permalink
doc/nix fmt: Do not document behavior we do not control
Browse files Browse the repository at this point in the history
This leads to confusion about what the command does.
E.g. #9359

- Move the description up

- Remove details about the individual formatters

(cherry picked from commit 8c4842d)
  • Loading branch information
roberth authored and mergify[bot] committed Jan 10, 2025
1 parent e0c8b0f commit 24e63b1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 16 deletions.
24 changes: 9 additions & 15 deletions src/nix/fmt.md
Original file line number Diff line number Diff line change
@@ -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):
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.

)""
2 changes: 1 addition & 1 deletion tests/functional/fmt.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down

0 comments on commit 24e63b1

Please sign in to comment.