Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gerschtli/nix-formatter-pack
Collection of several nix formatters
https://github.com/gerschtli/nix-formatter-pack
Last synced: 2 months ago
JSON representation
Collection of several nix formatters
- Host: GitHub
- URL: https://github.com/gerschtli/nix-formatter-pack
- Owner: Gerschtli
- License: mit
- Created: 2022-10-16T01:48:19.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-20T17:30:03.000Z (2 months ago)
- Last Synced: 2024-10-20T21:14:52.748Z (2 months ago)
- Language: Nix
- Homepage: https://gerschtli.github.io/nix-formatter-pack/
- Size: 41 KB
- Stars: 19
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nix formatter pack
With this project you can combine the simplicity of [`nix fmt`][nix-fmt-manual] with several static code analysis and
formatting tools.
Currently supported tools:
- [alejandra][alejandra]
- [deadnix][deadnix]
- [nixfmt][nixfmt]
- [nixpkgs-fmt][nixpkgs-fmt]
- [statix][statix]
For the list of available options, see the [manual][manual].
## Usage
**Hint**: To get started quickly, have a look at the provided nix templates in [./templates](./templates).
### For `nix fmt`
Set the special flake output `formatter` like the following:
```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/release-22.05";
nix-formatter-pack.url = "github:Gerschtli/nix-formatter-pack";
};
outputs = { self, nixpkgs, nix-formatter-pack }: {
formatter.x86_64-linux = nix-formatter-pack.lib.mkFormatter {
inherit nixpkgs;
system = "x86_64-linux";
# or a custom instance of nixpkgs:
# pkgs = import nixpkgs { inherit system; };
# extensible with custom modules:
# extraModules = [ otherFlake.nixFormatterPackModules.default ];
config = {
# define custom formatters:
# formatters.customFormatter.commandFn =
# { checkOnly, files, ... }:
# ''
# ${customFormatter}/bin/customFormatter ${if checkOnly then "--check" else "--fix"} ${files}
# '';
tools = {
deadnix.enable = true;
nixpkgs-fmt.enable = true;
statix.enable = true;
};
};
};
};
}
```
With this configuration, `nix fmt` will format your complete flake with the configured tools. `nix fmt -- --check` only
reports if any tool found an issue and fails with a non-zero exit code if any issue has been found, recommended for
usage in CI.
For more information, see `nix fmt -- --help`.
### For `nix flake check`
It can also be used as a [`nix flake check`][nix-flake-check-manual] like the following:
```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/release-22.05";
nix-formatter-pack.url = "github:Gerschtli/nix-formatter-pack";
};
outputs = { self, nixpkgs, nix-formatter-pack }: {
checks.x86_64-linux.nix-formatter-pack = nix-formatter-pack.lib.mkCheck {
inherit nixpkgs;
system = "x86_64-linux";
# or a custom instance of nixpkgs:
# pkgs = import nixpkgs { inherit system; };
# extensible with custom modules:
# extraModules = [ otherFlake.nixFormatterPackModules.default ];
config = {
# define custom formatters:
# formatters.customFormatter.commandFn =
# { checkOnly, files, ... }:
# ''
# ${customFormatter}/bin/customFormatter ${if checkOnly then "--check" else "--fix"} ${files}
# '';
tools = {
deadnix.enable = true;
nixpkgs-fmt.enable = true;
statix.enable = true;
};
};
# specify which files to check
checkFiles = [ ./. ];
};
};
}
```
[manual]: https://gerschtli.github.io/nix-formatter-pack/
[alejandra]: https://github.com/kamadorueda/alejandra
[deadnix]: https://github.com/astro/deadnix
[nix-flake-check-manual]: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake-check.html
[nix-fmt-manual]: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-fmt.html
[nixfmt]: https://github.com/serokell/nixfmt
[nixpkgs-fmt]: https://github.com/nix-community/nixpkgs-fmt
[statix]: https://github.com/nerdypepper/statix