pyrox.dev
1# treefmt {#treefmt}
2
3[treefmt](https://github.com/numtide/treefmt) streamlines the process of applying formatters to your project, making it a breeze with just one command line.
4
5The [`treefmt` package](https://search.nixos.org/packages?channel=unstable&show=treefmt)
6provides functions for configuring treefmt using the module system, which are [documented below](#sec-functions-library-treefmt), along with [their options](#sec-treefmt-options-reference).
7
8Alternatively, treefmt can be configured using [treefmt-nix](https://github.com/numtide/treefmt-nix).
9
10```{=include=} sections auto-id-prefix=auto-generated-treefmt-functions
11treefmt-functions.section.md
12```
13
14## Options Reference {#sec-treefmt-options-reference}
15
16The following attributes can be passed to [`withConfig`](#pkgs.treefmt.withConfig) or [`evalConfig`](#pkgs.treefmt.evalConfig):
17
18```{=include=} options
19id-prefix: opt-treefmt-
20list-id: configuration-variable-list
21source: ../treefmt-options.json
22```
23