646b892680
Some checks failed
Periodic Merges (6h) / master → staging-nixos (push) Failing after 12m50s
Periodic Merges (6h) / master → staging-next (push) Failing after 12m54s
Periodic Merges (24h) / merge-base(master,staging) → haskell-updates (push) Failing after 11m54s
Periodic Merges (6h) / staging-next → staging (push) Failing after 12m13s
Periodic Merges (24h) / staging-next-25.05 → staging-25.05 (push) Failing after 13m24s
Periodic Merges (24h) / release-25.05 → staging-next-25.05 (push) Failing after 14m28s
24 lines
974 B
Markdown
24 lines
974 B
Markdown
# treefmt {#treefmt}
|
|
|
|
[treefmt](https://github.com/numtide/treefmt) streamlines the process of applying formatters to your project, making it a breeze with just one command line.
|
|
|
|
The [`treefmt` package](https://search.nixos.org/packages?channel=unstable&show=treefmt)
|
|
provides functions for configuring treefmt using the module system, which are [documented below](#sec-functions-library-treefmt), along with [their options](#sec-treefmt-options-reference).
|
|
|
|
Alternatively, treefmt can be configured using [treefmt-nix](https://github.com/numtide/treefmt-nix).
|
|
|
|
```{=include=} sections auto-id-prefix=auto-generated-treefmt-functions
|
|
treefmt-functions.section.md
|
|
```
|
|
|
|
## Options Reference {#sec-treefmt-options-reference}
|
|
|
|
The following attributes can be passed to [`withConfig`](#pkgs.treefmt.withConfig) or [`evalConfig`](#pkgs.treefmt.evalConfig):
|
|
|
|
```{=include=} options
|
|
id-prefix: opt-treefmt-
|
|
list-id: configuration-variable-list
|
|
source: ../treefmt-options.json
|
|
```
|
|
|