nixpkgs/doc/packages/treefmt.section.md

# 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
```
doc/packages: add treefmt section 2025-05-13 07:14:16 +01:00			`# 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)
doc/packages/treefmt: add option reference docs Add a `treefmt.optionsDoc` passthru, which is included on the treefmt section of the nixpkgs manual. This generates reference docs for options declared in `treefmt.evalConfig`. 2025-05-13 07:15:15 +01:00			`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).`
doc/packages: add treefmt section 2025-05-13 07:14:16 +01:00
			`Alternatively, treefmt can be configured using [treefmt-nix](https://github.com/numtide/treefmt-nix).`
doc/packages/treefmt: add function reference docs Add a `treefmt.functionsDoc` passthru, which is included on the treefmt section of the nixpkgs manual. This generates reference docs for functions defined in `pkgs/by-name/tr/treefmt/lib.nix`, using `nixdoc`. 2025-05-14 07:20:21 +01:00
			```{=include=} sections auto-id-prefix=auto-generated-treefmt-functions
			`treefmt-functions.section.md`
			```
doc/packages/treefmt: add option reference docs Add a `treefmt.optionsDoc` passthru, which is included on the treefmt section of the nixpkgs manual. This generates reference docs for options declared in `treefmt.evalConfig`. 2025-05-13 07:15:15 +01:00
			`## 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`
			```