treefmt-nix
When working on large code trees, it's common to have multiple code formatters run against it. And have one script that loops over all of them. treefmt makes that nicer.
- A unified CLI and output
- Run all the formatters in parallel.
- Cache which files have changed for super fast re-formatting.
- Just type treefmt in any folder and it reformats the whole code tree.
This module is defined in numtide/treefmt-nix. The treefmt repo is about the tool itself.
Installation
To use these options, add to your flake inputs:
treefmt-nix.url = "github:numtide/treefmt-nix";
and inside the mkFlake:
imports = [
inputs.treefmt-nix.flakeModule
];
Run nix flake lock and you're set.
Options
perSystem.treefmt
Project-level treefmt configuration
Use config.treefmt.build.wrapper to get access to the resulting treefmt
package based on this configuration.
By default treefmt-nix will set the formatter.<system> attribute of the flake,
used by the nix fmt command.
Type: submodule
Default:
{ }
Declared by:
perSystem.treefmt.enableDefaultExcludes
Enable the default excludes in the treefmt configuration.
Type: boolean
Default:
true
Declared by:
perSystem.treefmt.package
The treefmt package to use.
Type: package
Default:
pkgs.treefmt
Declared by:
perSystem.treefmt.build.check
Create a flake check to test that the given project tree is already formatted.
Input argument is the path to the project tree (usually ‘self’).
Type: function that evaluates to a(n) package
Default: Default check implementation
Declared by:
perSystem.treefmt.build.configFile
Contains the generated config file derived from the settings.
Type: absolute path
Declared by:
perSystem.treefmt.build.devShell
The development shell with treefmt and its underlying programs
Type: package (read only)
Declared by:
perSystem.treefmt.build.programs
Attrset of formatter programs enabled in treefmt configuration.
The key of the attrset is the formatter name, with the value being the package used to do the formatting.
Type: attribute set of package
Default: Programs used in configuration
Declared by:
perSystem.treefmt.build.wrapper
The treefmt package, wrapped with the config file.
Type: package
Default:
wrapped treefmt command
Declared by:
perSystem.treefmt.flakeCheck
Add a flake check to run treefmt
Type: boolean
Default:
true
Declared by:
perSystem.treefmt.flakeFormatter
Enables treefmt the default formatter used by the nix fmt command
Type: boolean
Default:
true
Declared by:
perSystem.treefmt.pkgs
Nixpkgs to use in treefmt.
Type: lazy attribute set of raw value
Default:
pkgs (module argument of perSystem)
Declared by:
perSystem.treefmt.programs.actionlint.enable
Whether to enable actionlint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.actionlint.package
The actionlint package to use.
Type: package
Default:
pkgs.actionlint
Declared by:
perSystem.treefmt.programs.actionlint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.actionlint.includes
Path / file patterns to include
Type: list of string
Default:
[
".github/workflows/*.yml"
".github/workflows/*.yaml"
]
Declared by:
perSystem.treefmt.programs.actionlint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.alejandra.enable
Whether to enable alejandra.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.alejandra.package
The alejandra package to use.
Type: package
Default:
pkgs.alejandra
Declared by:
perSystem.treefmt.programs.alejandra.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.alejandra.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nix"
]
Declared by:
perSystem.treefmt.programs.alejandra.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.asmfmt.enable
Whether to enable asmfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.asmfmt.package
The asmfmt package to use.
Type: package
Default:
pkgs.asmfmt
Declared by:
perSystem.treefmt.programs.asmfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.asmfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.s"
]
Declared by:
perSystem.treefmt.programs.asmfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.autocorrect.enable
Whether to enable autocorrect.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.autocorrect.package
The autocorrect package to use.
Type: package
Default:
pkgs.autocorrect
Declared by:
perSystem.treefmt.programs.autocorrect.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.autocorrect.includes
Path / file patterns to include
Type: list of string
Default:
[
"*"
]
Declared by:
perSystem.treefmt.programs.autocorrect.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.autocorrect.settings.context
Enable or disable in a specific context.
Type: null or (submodule)
Default:
null
Declared by:
perSystem.treefmt.programs.autocorrect.settings.context.codeblock
Enable or disable to format codeblock in Markdown or AsciiDoc etc.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"error"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.fileTypes
Configure the files associations, you config is higher priority than default.
Type: null or (attribute set of string)
Default:
null
Example:
{
"*.js" = "javascript";
".mdx" = "markdown";
Rakefile = "ruby";
rb = "ruby";
}
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules
Configure rules for autocorrect formatting.
Type: null or (submodule)
Default:
null
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.fullwidth
Convert to fullwidth.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"error"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.halfwidth-punctuation
Fullwidth punctuations to halfwidth in english.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"error"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.halfwidth-word
Fullwidth alphanumeric characters to halfwidth.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"error"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.no-space-fullwidth
Remove space near the fullwidth.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"error"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.space-backticks
Add space between ``, when near the CJK.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"error"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.space-bracket
Add space between brackets (), [] when near the CJK.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"error"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.space-dash
Add space between dash -.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"off"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.space-dollar
Add space between dollar $ when near the CJK.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"off"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.space-punctuation
Add space between some punctuations.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"error"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.space-word
Auto add spacing between CJK (Chinese, Japanese, Korean) and English words.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"off"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.rules.spellcheck
Spellcheck.
Type: null or one of “off”, “error”, “warning”
Default:
null
Example:
"warning"
Declared by:
perSystem.treefmt.programs.autocorrect.settings.spellcheck
Spellcheck configuration.
Type: null or (submodule)
Default:
null
Declared by:
perSystem.treefmt.programs.autocorrect.settings.spellcheck.words
Correct Words (Case insensitive) for by Spellcheck.
Type: null or (list of string)
Default:
null
Example:
[
"GitHub"
"App Store"
"AppStore = App Store"
"Git"
"Node.js"
"nodejs = Node.js"
"VIM"
"DNS"
"HTTP"
"SSL"
]
Declared by:
perSystem.treefmt.programs.autocorrect.settings.textRules
Configure special rules for some texts.
Type: null or (attribute set of (null or one of “off”, “error”, “warning”))
Default:
null
Example:
{
"Hello你好" = "warning";
"Hi你好" = "off";
}
Declared by:
perSystem.treefmt.programs.autocorrect.threads
Number of threads, 0 - use number of CPU. [default: 0]
Type: null or signed integer
Default:
null
Example:
2
Declared by:
perSystem.treefmt.programs.beautysh.enable
Whether to enable beautysh.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.beautysh.package
The beautysh package to use.
Type: package
Default:
pkgs.beautysh
Declared by:
perSystem.treefmt.programs.beautysh.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.beautysh.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.sh"
]
Declared by:
perSystem.treefmt.programs.beautysh.indent_size
Sets the number of spaces to be used in indentation.
Type: signed integer
Default:
2
Example:
4
Declared by:
perSystem.treefmt.programs.beautysh.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.biome.enable
Whether to enable biome.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.biome.package
The biome package to use.
Type: package
Default:
pkgs.biome
Declared by:
perSystem.treefmt.programs.biome.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.biome.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.js"
"*.ts"
"*.mjs"
"*.mts"
"*.cjs"
"*.cts"
"*.jsx"
"*.tsx"
"*.d.ts"
"*.d.cts"
"*.d.mts"
"*.json"
"*.jsonc"
"*.css"
]
Declared by:
perSystem.treefmt.programs.biome.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.biome.settings.assist.actions.source.organizeImports
Enables Biome’s sort imports.
Type: one of “on”, “off”
Default:
"on"
Example:
"on"
Declared by:
perSystem.treefmt.programs.biome.settings.css.formatter.enabled
Enables Biome’s formatter for CSS (and its super languages) files.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.biome.settings.css.formatter.indentStyle
The style of the indentation. It can be tab or space.
Type: one of “tab”, “space”
Default:
"tab"
Example:
"space"
Declared by:
perSystem.treefmt.programs.biome.settings.css.formatter.indentWidth
How big the indentation should be.
Type: signed integer
Default:
2
Example:
4
Declared by:
perSystem.treefmt.programs.biome.settings.css.formatter.lineEnding
The type of line ending.
Type: one of “lf”, “crlf”, “cr”
Default:
"lf"
Example:
"cr"
Declared by:
perSystem.treefmt.programs.biome.settings.css.formatter.lineWidth
How many characters can be written on a single line.
Type: signed integer
Default:
80
Example:
90
Declared by:
perSystem.treefmt.programs.biome.settings.css.formatter.quoteStyle
The type of quote used when representing string literals. It can be single or double.
Type: one of “single”, “double”
Default:
"double"
Example:
"single"
Declared by:
perSystem.treefmt.programs.biome.settings.css.linter.enabled
Enables Biome’s linter for CSS (and its super languages) files.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.biome.settings.css.parser.cssModules
Enables parsing of CSS modules
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.biome.settings.formatter.enabled
Enables Biome’s formatter
Type: boolean
Default:
true
Example:
false
Declared by:
perSystem.treefmt.programs.biome.settings.formatter.formatWithErrors
Allows to format a document that has syntax errors.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.biome.settings.formatter.ignore
A list of Unix shell style patterns. Biome ignores files and folders that match these patterns.
Type: list of string
Default:
[ ]
Example:
[
"scripts/*.js"
]
Declared by:
perSystem.treefmt.programs.biome.settings.formatter.include
A list of Unix shell style patterns. Biome handles only the files and folders that match these patterns.
[!Caution] When both include and ignore are specified, ignore takes precedence over include
Type: list of string
Default:
[ ]
Example:
[
"scripts/*.js"
]
Declared by:
perSystem.treefmt.programs.biome.settings.formatter.indentStyle
The style of the indentation. It can be tab or space.
Type: one of “tab”, “space”
Default:
"tab"
Example:
"space"
Declared by:
perSystem.treefmt.programs.biome.settings.formatter.indentWidth
How big the indentation should be.
Type: signed integer
Default:
2
Example:
4
Declared by:
perSystem.treefmt.programs.biome.settings.formatter.lineEnding
The type of line ending.
Type: one of “lf”, “crlf”, “cr”
Default:
"lf"
Example:
"cr"
Declared by:
perSystem.treefmt.programs.biome.settings.formatter.lineWidth
How many characters can be written on a single line.
Type: signed integer
Default:
80
Example:
90
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.enabled
Enables Biome’s formatter for JavaScript (and its super languages) files.
Type: boolean
Default:
true
Example:
false
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.arrowParentheses
Whether to add non-necessary parentheses to arrow functions:
always, the parentheses are always added;asNeeded, the parentheses are added only when they are needed;
Type: one of “always”, “asNeeded”
Default:
"always"
Example:
"asNeeded"
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.bracketSameLine
Choose whether the ending > of a multi-line JSX element should be on the last attribute line or not
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.bracketSpacing
Choose whether spaces should be added between brackets and inner values
Type: boolean
Default:
true
Example:
false
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.indentStyle
The style of the indentation. It can be tab or space.
Type: one of “tab”, “space”
Default:
"tab"
Example:
"space"
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.indentWidth
How big the indentation should be.
Type: signed integer
Default:
2
Example:
4
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.jsxQuoteStyle
The type of quote used when representing jsx string literals. It can be single or double.
Type: one of “single”, “double”
Default:
"double"
Example:
"single"
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.lineEnding
The type of line ending.
Type: one of “lf”, “crlf”, “cr”
Default:
"lf"
Example:
"cr"
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.lineWidth
How many characters can be written on a single line.
Type: signed integer
Default:
80
Example:
90
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.quoteProperties
When properties inside objects should be quoted. It can be asNeeded or preserve.
Type: one of “asNeeded”, “preserve”
Default:
"asNeeded"
Example:
"preserve"
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.quoteStyle
The type of quote used when representing string literals. It can be single or double.
Type: one of “single”, “double”
Default:
"double"
Example:
"single"
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.semicolons
It configures where the formatter prints semicolons:
always, the semicolons is always added at the end of each statement;asNeeded, the semicolons are added only in places where it’s needed, to protect from ASI
Type: one of “always”, “asNeeded”
Default:
"always"
Example:
"asNeeded"
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.formatter.trailingComma
Print trailing commas wherever possible in multi-line comma-separated syntactic structures. Possible values:
all, the trailing comma is always addedes5, the trailing comma is added only in places where it’s supported by older version of JavaScriptnone, trailing commas are never added
Type: one of “all”, “es5”, “none”
Default:
"all"
Example:
"none"
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.globals
A list of global names that Biome should ignore
Type: list of string
Default:
[ ]
Example:
[
"$"
"_"
"externalVariable"
]
Declared by:
perSystem.treefmt.programs.biome.settings.javascript.parser.unsafeParameterDecoratorsEnabled
Allows to support the unsafe/experimental parameter decorators.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.biome.settings.json.formatter.enabled
Enables Biome’s formatter for JSON (and its super languages) files.
Type: boolean
Default:
true
Example:
false
Declared by:
perSystem.treefmt.programs.biome.settings.json.formatter.indentStyle
The style of the indentation. It can be tab or space.
Type: one of “tab”, “space”
Default:
"tab"
Example:
"space"
Declared by:
perSystem.treefmt.programs.biome.settings.json.formatter.indentWidth
How big the indentation should be.
Type: signed integer
Default:
2
Example:
4
Declared by:
perSystem.treefmt.programs.biome.settings.json.formatter.lineEnding
The type of line ending.
Type: one of “lf”, “crlf”, “cr”
Default:
"lf"
Example:
"cr"
Declared by:
perSystem.treefmt.programs.biome.settings.json.formatter.lineWidth
How many characters can be written on a single line.
Type: signed integer
Default:
80
Example:
90
Declared by:
perSystem.treefmt.programs.biome.settings.json.parser.allowComments
Enables the parsing of comments in JSON files.
Type: boolean
Default:
true
Example:
false
Declared by:
perSystem.treefmt.programs.biome.settings.json.parser.allowTrailingCommas
Enables the parsing of trailing Commas in JSON files.
Type: boolean
Default:
true
Example:
false
Declared by:
perSystem.treefmt.programs.black.enable
Whether to enable black.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.black.package
The black package to use.
Type: package
Default:
pkgs.black
Declared by:
perSystem.treefmt.programs.black.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.black.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.py"
"*.pyi"
]
Declared by:
perSystem.treefmt.programs.black.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.buf.enable
Whether to enable buf.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.buf.package
The buf package to use.
Type: package
Default:
pkgs.buf
Declared by:
perSystem.treefmt.programs.buf.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.buf.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.proto"
]
Declared by:
perSystem.treefmt.programs.buf.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.buildifier.enable
Whether to enable buildifier.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.buildifier.package
The buildifier package to use.
Type: package
Default:
pkgs.buildifier
Declared by:
perSystem.treefmt.programs.buildifier.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.buildifier.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.bazel"
"*.bzl"
]
Declared by:
perSystem.treefmt.programs.buildifier.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.cabal-fmt.enable
Whether to enable cabal-fmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.cabal-fmt.package
The cabal-fmt package to use.
Type: package
Default:
pkgs.haskellPackages.cabal-fmt
Declared by:
perSystem.treefmt.programs.cabal-fmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.cabal-fmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.cabal"
]
Declared by:
perSystem.treefmt.programs.cabal-fmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.cabal-gild.enable
Whether to enable cabal-gild.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.cabal-gild.package
The cabal-gild package to use.
Type: package
Default:
pkgs.haskellPackages.cabal-gild
Declared by:
perSystem.treefmt.programs.cabal-gild.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.cabal-gild.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.cabal"
"cabal.project"
"cabal.project.local"
]
Declared by:
perSystem.treefmt.programs.cabal-gild.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.clang-format.enable
Whether to enable clang-format.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.clang-format.package
The clang-tools package to use.
Type: package
Default:
pkgs.clang-tools
Declared by:
perSystem.treefmt.programs.clang-format.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.clang-format.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.c"
"*.cc"
"*.cpp"
"*.h"
"*.hh"
"*.hpp"
"*.glsl"
"*.vert"
".tesc"
".tese"
".geom"
".frag"
".comp"
]
Declared by:
perSystem.treefmt.programs.clang-format.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.cljfmt.enable
Whether to enable cljfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.cljfmt.package
The cljfmt package to use.
Type: package
Default:
pkgs.cljfmt
Declared by:
perSystem.treefmt.programs.cljfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.cljfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.clj"
"*.cljc"
"*.cljs"
"*.cljx"
]
Declared by:
perSystem.treefmt.programs.cljfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.cmake-format.enable
Whether to enable cmake-format.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.cmake-format.package
The cmake-format package to use.
Type: package
Default:
pkgs.cmake-format
Declared by:
perSystem.treefmt.programs.cmake-format.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.cmake-format.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.cmake"
"CMakeLists.txt"
]
Declared by:
perSystem.treefmt.programs.cmake-format.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.csharpier.enable
Whether to enable csharpier.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.csharpier.package
The csharpier package to use.
Type: package
Default:
pkgs.csharpier
Declared by:
perSystem.treefmt.programs.csharpier.dotnet-sdk
The dotnet-sdk package to use.
Type: package
Default:
pkgs.dotnet-sdk
Declared by:
perSystem.treefmt.programs.csharpier.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.csharpier.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.cs"
]
Declared by:
perSystem.treefmt.programs.csharpier.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.cue.enable
Whether to enable cue.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.cue.package
The cue package to use.
Type: package
Default:
pkgs.cue
Declared by:
perSystem.treefmt.programs.cue.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.cue.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.cue"
]
Declared by:
perSystem.treefmt.programs.cue.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.d2.enable
Whether to enable d2.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.d2.package
The d2 package to use.
Type: package
Default:
pkgs.d2
Declared by:
perSystem.treefmt.programs.d2.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.d2.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.d2"
]
Declared by:
perSystem.treefmt.programs.d2.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.dart-format.enable
Whether to enable dart-format.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.dart-format.package
The dart package to use.
Type: package
Default:
pkgs.dart
Declared by:
perSystem.treefmt.programs.dart-format.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.dart-format.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.dart"
]
Declared by:
perSystem.treefmt.programs.dart-format.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.deadnix.enable
Whether to enable deadnix.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.deadnix.package
The deadnix package to use.
Type: package
Default:
pkgs.deadnix
Declared by:
perSystem.treefmt.programs.deadnix.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.deadnix.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nix"
]
Declared by:
perSystem.treefmt.programs.deadnix.no-lambda-arg
Whether to enable Don’t check lambda parameter arguments.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.deadnix.no-lambda-pattern-names
Whether to enable Don’t check lambda attrset pattern names (don’t break nixpkgs callPackage).
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.deadnix.no-underscore
Whether to enable Don’t check any bindings that start with a _.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.deadnix.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.deno.enable
Whether to enable deno.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.deno.package
The deno package to use.
Type: package
Default:
pkgs.deno
Declared by:
perSystem.treefmt.programs.deno.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.deno.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.css"
"*.html"
"*.js"
"*.json"
"*.jsonc"
"*.jsx"
"*.less"
"*.markdown"
"*.md"
"*.sass"
"*.scss"
"*.ts"
"*.tsx"
"*.yaml"
"*.yml"
]
Declared by:
perSystem.treefmt.programs.deno.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.dhall.enable
Whether to enable dhall.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.dhall.package
The dhall package to use.
Type: package
Default:
pkgs.dhall
Declared by:
perSystem.treefmt.programs.dhall.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.dhall.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.dhall"
]
Declared by:
perSystem.treefmt.programs.dhall.lint
Whether to lint in addition to formatting.
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.dhall.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.dnscontrol.enable
Whether to enable dnscontrol.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.dnscontrol.package
The dnscontrol package to use.
Type: package
Default:
pkgs.dnscontrol
Declared by:
perSystem.treefmt.programs.dnscontrol.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.dnscontrol.includes
Path / file patterns to include
Type: list of string
Default:
[
"dnsconfig.js"
]
Declared by:
perSystem.treefmt.programs.dnscontrol.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.dockfmt.enable
Whether to enable dockfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.dockfmt.package
The dockfmt package to use.
Type: package
Default:
pkgs.dockfmt
Declared by:
perSystem.treefmt.programs.dockfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.dockfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"Dockerfile"
"*.Dockerfile"
"Dockerfile.*"
]
Declared by:
perSystem.treefmt.programs.dockfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.dos2unix.enable
Whether to enable dos2unix.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.dos2unix.package
The dos2unix package to use.
Type: package
Default:
pkgs.dos2unix
Declared by:
perSystem.treefmt.programs.dos2unix.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.dos2unix.includes
Path / file patterns to include
Type: list of string
Default:
[
"*"
]
Declared by:
perSystem.treefmt.programs.dos2unix.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.dprint.enable
Whether to enable dprint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.dprint.package
The dprint package to use.
Type: package
Default:
pkgs.dprint
Declared by:
perSystem.treefmt.programs.dprint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.dprint.includes
Path / file patterns to include
Type: list of string
Default:
[
".*"
]
Declared by:
perSystem.treefmt.programs.dprint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.dprint.settings
Configuration to generate dprint.json with
Type: JSON value
Default:
{ }
Declared by:
perSystem.treefmt.programs.dprint.settings.extends
Configurations to extend.
Type: null or string or list of string
Default:
null
Example:
"https://dprint.dev/path/to/config/file.v1.json"
Declared by:
perSystem.treefmt.programs.dprint.settings.incremental
Whether to format files only when they change.
Type: null or boolean
Default:
null
Example:
true
Declared by:
perSystem.treefmt.programs.dprint.settings.indentWidth
The number of characters for an indent
Type: null or signed integer
Default:
null
Example:
2
Declared by:
perSystem.treefmt.programs.dprint.settings.lineWidth
The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.
Type: null or signed integer
Default:
null
Example:
80
Declared by:
perSystem.treefmt.programs.dprint.settings.newLineKind
The kind of newline to use (one of: auto, crlf, lf, system).
Type: null or string
Default:
null
Example:
"auto"
Declared by:
perSystem.treefmt.programs.dprint.settings.plugins
Array of plugin URLs to format files.
Type: null or (list of string)
Default:
null
Example:
# (recommended) using plugins from nixpkgs
# plugins is the list of all available dprint plugins in nixpkgs
(pkgs.dprint-plugins.getPluginList (
plugins: with plugins; [
dprint-plugin-toml
dprint-plugin-dockerfile
g-plane-pretty_yaml
# (pkgs.callPackage ./dprint/plugins/sample.nix {})
]
))
# (not recommended) using url plugins
# treefmt then only works outside the nix sandbox, so treefmt nix flake check will fail
++ [
"https://plugins.dprint.dev/json-0.17.2.wasm"
"https://plugins.dprint.dev/markdown-0.15.2.wasm"
"https://plugins.dprint.dev/typescript-0.84.4.wasm"
]
Declared by:
perSystem.treefmt.programs.dprint.settings.useTabs
Whether to use tabs (true) or spaces (false) for indentation.
Type: null or boolean
Default:
null
Example:
true
Declared by:
perSystem.treefmt.programs.efmt.enable
Whether to enable efmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.efmt.package
The efmt package to use.
Type: package
Default:
pkgs.efmt
Declared by:
perSystem.treefmt.programs.efmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.efmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.erl"
"*.hrl"
"*.app"
"*.app.src"
"*.config"
"*.script"
"*.escript"
]
Declared by:
perSystem.treefmt.programs.efmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.elm-format.enable
Whether to enable elm-format.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.elm-format.package
The elm-format package to use.
Type: package
Default:
pkgs.elmPackages.elm-format
Declared by:
perSystem.treefmt.programs.elm-format.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.elm-format.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.elm"
]
Declared by:
perSystem.treefmt.programs.elm-format.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.erlfmt.enable
Whether to enable erlfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.erlfmt.package
The erlfmt package to use.
Type: package
Default:
pkgs.erlfmt
Declared by:
perSystem.treefmt.programs.erlfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.erlfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.erl"
"*.hrl"
"*.app"
"*.app.src"
"*.config"
"*.script"
"*.escript"
]
Declared by:
perSystem.treefmt.programs.erlfmt.print-width
The line length that formatter would wrap on
Type: signed integer
Default:
100
Example:
80
Declared by:
perSystem.treefmt.programs.erlfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.fantomas.enable
Whether to enable fantomas.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.fantomas.package
The fantomas package to use.
Type: package
Default:
pkgs.fantomas
Declared by:
perSystem.treefmt.programs.fantomas.dotnet-sdk
The dotnet-sdk package to use.
Type: package
Default:
pkgs.dotnet-sdk
Declared by:
perSystem.treefmt.programs.fantomas.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.fantomas.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.fs"
"*.fsx"
"*.fsi"
"*.ml"
"*.mli"
]
Declared by:
perSystem.treefmt.programs.fantomas.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.fish_indent.enable
Whether to enable fish_indent.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.fish_indent.package
The fish package to use.
Type: package
Default:
pkgs.fish
Declared by:
perSystem.treefmt.programs.fish_indent.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.fish_indent.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.fish"
]
Declared by:
perSystem.treefmt.programs.fish_indent.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.fnlfmt.enable
Whether to enable fnlfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.fnlfmt.package
The fnlfmt package to use.
Type: package
Default:
pkgs.fnlfmt
Declared by:
perSystem.treefmt.programs.fnlfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.fnlfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.fnl"
]
Declared by:
perSystem.treefmt.programs.fnlfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.formatjson5.enable
Whether to enable formatjson5.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.formatjson5.package
The formatjson5 package to use.
Type: package
Default:
pkgs.formatjson5
Declared by:
perSystem.treefmt.programs.formatjson5.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.formatjson5.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.json5"
]
Declared by:
perSystem.treefmt.programs.formatjson5.indent
Indent by the given number of spaces
Type: signed integer
Default:
4
Declared by:
perSystem.treefmt.programs.formatjson5.noTrailingCommas
Suppress trailing commas (otherwise added by default)
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.formatjson5.oneElementLines
Objects or arrays with a single child should collapse to a single line
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.formatjson5.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.formatjson5.sortArrays
Sort arrays of primitive values (string, number, boolean, or null) lexicographically
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.fourmolu.enable
Whether to enable fourmolu.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.fourmolu.package
The fourmolu package to use.
Type: package
Default:
pkgs.haskellPackages.fourmolu
Declared by:
perSystem.treefmt.programs.fourmolu.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.fourmolu.ghcOpts
Which GHC language extensions to enable
Type: unspecified value
Default:
[
"BangPatterns"
"PatternSynonyms"
"TypeApplications"
]
Declared by:
perSystem.treefmt.programs.fourmolu.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.hs"
]
Declared by:
perSystem.treefmt.programs.fourmolu.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.fprettify.enable
Whether to enable fprettify.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.fprettify.package
The fprettify package to use.
Type: package
Default:
pkgs.fprettify
Declared by:
perSystem.treefmt.programs.fprettify.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.fprettify.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.f90"
]
Declared by:
perSystem.treefmt.programs.fprettify.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.gdformat.enable
Whether to enable gdformat.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.gdformat.package
The gdtoolkit_4 package to use.
Type: package
Default:
pkgs.gdtoolkit_4
Declared by:
perSystem.treefmt.programs.gdformat.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.gdformat.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.gd"
]
Declared by:
perSystem.treefmt.programs.gdformat.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.genemichaels.enable
Whether to enable genemichaels, a Rust code formatter.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.genemichaels.package
The genemichaels package to use.
Type: package
Default:
pkgs.genemichaels
Declared by:
perSystem.treefmt.programs.genemichaels.excludes
Path / file patterns to exclude for genemichaels.
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.genemichaels.includes
Path / file patterns to include for genemichaels.
Type: list of string
Default:
[
"*.rs"
]
Declared by:
perSystem.treefmt.programs.genemichaels.settings.comment_errors_fatal
If reformatting comments results in an error, abort formatting the document.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.genemichaels.settings.comment_width
Maximum relative line length for comments (past the comment
indentation level). Can be null to disable relative wrapping. If
disabled, still wraps at max_width.
Type: null or (positive integer, meaning >0)
Default:
80
Example:
null
Declared by:
perSystem.treefmt.programs.genemichaels.settings.keep_max_blank_lines
Genemichaels will replace line breaks with it’s own deterministic line breaks. You can use this to keep extra line breaks (1 will keep up to 1 extra line break) during comment extraction. This is unused during formatting.
Type: unsigned integer, meaning >=0
Default:
0
Example:
1
Declared by:
perSystem.treefmt.programs.genemichaels.settings.max_width
Ideal maximum line width. If there’s an unbreakable element the line won’t be split.
Type: positive integer, meaning >0
Default:
120
Example:
80
Declared by:
perSystem.treefmt.programs.genemichaels.settings.root_splits
When breaking a child element, also break all parent elements.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.genemichaels.settings.split_attributes
Break a #[] on a separate line before the element it’s associated
with.
Type: boolean
Default:
true
Example:
false
Declared by:
perSystem.treefmt.programs.genemichaels.settings.split_brace_threshold
Break a () or {} if it has greater than this number of children.
Set to null to disable breaking due to high child counts.
Type: null or (positive integer, meaning >0)
Default:
1
Example:
null
Declared by:
perSystem.treefmt.programs.genemichaels.settings.split_where
Put the where clause on a new line.
Type: boolean
Default:
true
Example:
false
Declared by:
perSystem.treefmt.programs.genemichaels.settingsFile
The configuration file used by genemichaels.
Type: absolute path
Default:
Generated JSON file from perSystem.treefmt.programs.genemichaels.settings
Example:
./.genemichaels.json
Declared by:
perSystem.treefmt.programs.genemichaels.threadCount
How many threads to use for formatting multiple files. Set to null to
default to the number of cores on the system.
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
1
Declared by:
perSystem.treefmt.programs.gleam.enable
Whether to enable gleam.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.gleam.package
The gleam package to use.
Type: package
Default:
pkgs.gleam
Declared by:
perSystem.treefmt.programs.gleam.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.gleam.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.gleam"
]
Declared by:
perSystem.treefmt.programs.gleam.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.gofmt.enable
Whether to enable gofmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.gofmt.package
The go package to use.
Type: package
Default:
pkgs.go
Declared by:
perSystem.treefmt.programs.gofmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[
"vendor/*"
]
Declared by:
perSystem.treefmt.programs.gofmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.go"
]
Declared by:
perSystem.treefmt.programs.gofmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.gofumpt.enable
Whether to enable gofumpt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.gofumpt.package
The gofumpt package to use.
Type: package
Default:
pkgs.gofumpt
Declared by:
perSystem.treefmt.programs.gofumpt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[
"vendor/*"
]
Declared by:
perSystem.treefmt.programs.gofumpt.extra
Whether to enable extra rules.
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.gofumpt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.go"
]
Declared by:
perSystem.treefmt.programs.gofumpt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.goimports.enable
Whether to enable goimports.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.goimports.package
The gotools package to use.
Type: package
Default:
pkgs.gotools
Declared by:
perSystem.treefmt.programs.goimports.excludes
Path / file patterns to exclude
Type: list of string
Default:
[
"vendor/*"
]
Declared by:
perSystem.treefmt.programs.goimports.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.go"
]
Declared by:
perSystem.treefmt.programs.goimports.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.golines.enable
Whether to enable golines.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.golines.package
The golines package to use.
Type: package
Default:
pkgs.golines
Declared by:
perSystem.treefmt.programs.golines.excludes
Path / file patterns to exclude
Type: list of string
Default:
[
"vendor/*"
]
Declared by:
perSystem.treefmt.programs.golines.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.go"
]
Declared by:
perSystem.treefmt.programs.golines.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.google-java-format.enable
Whether to enable google-java-format.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.google-java-format.package
The google-java-format package to use.
Type: package
Default:
pkgs.google-java-format
Declared by:
perSystem.treefmt.programs.google-java-format.aospStyle
Whether to use AOSP (Android Open Source Project) indentation. In a few words, use 4-space indentation rather than the conventional 2-space indentation width that Google uses.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.google-java-format.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.google-java-format.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.java"
]
Declared by:
perSystem.treefmt.programs.google-java-format.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.hclfmt.enable
Whether to enable hclfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.hclfmt.package
The hclfmt package to use.
Type: package
Default:
pkgs.hclfmt
Declared by:
perSystem.treefmt.programs.hclfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.hclfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.hcl"
]
Declared by:
perSystem.treefmt.programs.hclfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.hlint.enable
Whether to enable hlint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.hlint.package
The hlint package to use.
Type: package
Default:
pkgs.hlint
Declared by:
perSystem.treefmt.programs.hlint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.hlint.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.hs"
]
Declared by:
perSystem.treefmt.programs.hlint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.hujsonfmt.enable
Whether to enable hujsonfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.hujsonfmt.package
The hujsonfmt package to use.
Type: package
Default:
pkgs.hujsonfmt
Declared by:
perSystem.treefmt.programs.hujsonfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.hujsonfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.hujson"
]
Declared by:
perSystem.treefmt.programs.hujsonfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.isort.enable
Whether to enable isort.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.isort.package
The isort package to use.
Type: package
Default:
pkgs.isort
Declared by:
perSystem.treefmt.programs.isort.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.isort.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.py"
"*.pyi"
]
Declared by:
perSystem.treefmt.programs.isort.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.isort.profile
The profile to use for isort.
Type: string
Default:
""
Declared by:
perSystem.treefmt.programs.jsonfmt.enable
Whether to enable jsonfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.jsonfmt.package
The jsonfmt package to use.
Type: package
Default:
pkgs.jsonfmt
Declared by:
perSystem.treefmt.programs.jsonfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.jsonfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.json"
]
Declared by:
perSystem.treefmt.programs.jsonfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.jsonnet-lint.enable
Whether to enable jsonnet-lint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.jsonnet-lint.package
The go-jsonnet package to use.
Type: package
Default:
pkgs.go-jsonnet
Declared by:
perSystem.treefmt.programs.jsonnet-lint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.jsonnet-lint.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.jsonnet"
"*.libsonnet"
]
Declared by:
perSystem.treefmt.programs.jsonnet-lint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.jsonnetfmt.enable
Whether to enable jsonnetfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.jsonnetfmt.package
The go-jsonnet package to use.
Type: package
Default:
pkgs.go-jsonnet
Declared by:
perSystem.treefmt.programs.jsonnetfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.jsonnetfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.jsonnet"
"*.libsonnet"
]
Declared by:
perSystem.treefmt.programs.jsonnetfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.just.enable
Whether to enable just.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.just.package
The just package to use.
Type: package
Default:
pkgs.just
Declared by:
perSystem.treefmt.programs.just.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.just.includes
Path / file patterns to include
Type: list of string
Default:
[
"[Jj][Uu][Ss][Tt][Ff][Ii][Ll][Ee]"
"*/[Jj][Uu][Ss][Tt][Ff][Ii][Ll][Ee]"
".[Jj][Uu][Ss][Tt][Ff][Ii][Ll][Ee]"
"*/.[Jj][Uu][Ss][Tt][Ff][Ii][Ll][Ee]"
"*.[Jj][Uu][Ss][Tt]"
"*.[Jj][Uu][Ss][Tt][Ff][Ii][Ll][Ee]"
]
Declared by:
perSystem.treefmt.programs.just.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.kdlfmt.enable
Whether to enable kdlfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.kdlfmt.package
The kdlfmt package to use.
Type: package
Default:
pkgs.kdlfmt
Declared by:
perSystem.treefmt.programs.kdlfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.kdlfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.kdl"
]
Declared by:
perSystem.treefmt.programs.kdlfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.keep-sorted.enable
Whether to enable keep-sorted.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.keep-sorted.package
The keep-sorted package to use.
Type: package
Default:
pkgs.keep-sorted
Declared by:
perSystem.treefmt.programs.keep-sorted.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.keep-sorted.includes
Path / file patterns to include
Type: list of string
Default:
[
"*"
]
Declared by:
perSystem.treefmt.programs.keep-sorted.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.ktfmt.enable
Whether to enable ktfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.ktfmt.package
The ktfmt package to use.
Type: package
Default:
pkgs.ktfmt
Declared by:
perSystem.treefmt.programs.ktfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.ktfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.kt"
"*.kts"
]
Declared by:
perSystem.treefmt.programs.ktfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.ktlint.enable
Whether to enable ktlint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.ktlint.package
The ktlint package to use.
Type: package
Default:
pkgs.ktlint
Declared by:
perSystem.treefmt.programs.ktlint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.ktlint.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.kt"
"*.kts"
]
Declared by:
perSystem.treefmt.programs.ktlint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.latexindent.enable
Whether to enable latexindent.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.latexindent.package
The texliveMedium package to use.
Type: package
Default:
pkgs.texliveMedium
Declared by:
perSystem.treefmt.programs.latexindent.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.latexindent.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.tex"
"*.sty"
"*.cls"
"*.bib"
"*.cmh"
]
Declared by:
perSystem.treefmt.programs.latexindent.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.leptosfmt.enable
Whether to enable leptosfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.leptosfmt.package
The leptosfmt package to use.
Type: package
Default:
pkgs.leptosfmt
Declared by:
perSystem.treefmt.programs.leptosfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.leptosfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.rs"
]
Declared by:
perSystem.treefmt.programs.leptosfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.mdformat.enable
Whether to enable mdformat.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.mdformat.package
The mdformat package to use.
Type: package
Default:
pkgs.python3Packages.mdformat
Declared by:
perSystem.treefmt.programs.mdformat.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.mdformat.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.md"
]
Declared by:
perSystem.treefmt.programs.mdformat.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.mdformat.settings.end-of-line
Output file line ending mode.
Type: null or one of “crlf”, “lf”, “keep”
Default:
null
Example:
"lf"
Declared by:
perSystem.treefmt.programs.mdformat.settings.number
Apply consecutive numbering to ordered lists.
Type: boolean
Default:
false
Example:
false
Declared by:
perSystem.treefmt.programs.mdformat.settings.wrap
Paragraph word wrap mode. Set to an INTEGER to wrap at that length.
Type: null or signed integer or one of “keep”, “no”
Default:
null
Example:
"keep"
Declared by:
perSystem.treefmt.programs.mdsh.enable
Whether to enable mdsh.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.mdsh.package
The mdsh package to use.
Type: package
Default:
pkgs.mdsh
Declared by:
perSystem.treefmt.programs.mdsh.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.mdsh.includes
Path / file patterns to include
Type: list of string
Default:
[
"README.md"
]
Declared by:
perSystem.treefmt.programs.mdsh.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.meson.enable
Whether to enable meson.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.meson.package
The meson package to use.
Type: package
Default:
pkgs.meson
Declared by:
perSystem.treefmt.programs.meson.editorconfig
Try to read configuration from .editorconfig
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.meson.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.meson.includes
Path / file patterns to include
Type: list of string
Default:
[
"meson.build"
"meson.options"
"meson_options.txt"
"*/meson.build"
"*/meson.options"
"*/meson_options.txt"
]
Declared by:
perSystem.treefmt.programs.meson.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.mix-format.enable
Whether to enable mix-format.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.mix-format.package
The elixir package to use.
Type: package
Default:
pkgs.elixir
Declared by:
perSystem.treefmt.programs.mix-format.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.mix-format.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.ex"
"*.exs"
]
Declared by:
perSystem.treefmt.programs.mix-format.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.muon.enable
Whether to enable muon.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.muon.package
The muon package to use.
Type: package
Default:
pkgs.muon
Declared by:
perSystem.treefmt.programs.muon.editorconfig
Try to read configuration from .editorconfig
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.muon.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.muon.includes
Path / file patterns to include
Type: list of string
Default:
[
"meson.build"
"meson.options"
"meson_options.txt"
"*/meson.build"
"*/meson.options"
"*/meson_options.txt"
]
Declared by:
perSystem.treefmt.programs.muon.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.mypy.enable
Whether to enable mypy.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.mypy.package
The mypy package to use.
Type: package
Default:
pkgs.mypy
Declared by:
perSystem.treefmt.programs.mypy.directories
Directories to run mypy in
Type: attribute set of (submodule)
Default:
{
"" = { };
}
Example:
{
"" = {
modules = [
"mymodule"
"tests"
];
};
subdir = { };
}
Declared by:
perSystem.treefmt.programs.mypy.directories.<name>.directory
Directory to run mypy in
Type: string
Default:
"‹name›"
Declared by:
perSystem.treefmt.programs.mypy.directories.<name>.extraPythonPackages
Extra packages to add to PYTHONPATH
Type: list of package
Default:
[ ]
Example: [ pkgs.python3.pkgs.requests ]
Declared by:
perSystem.treefmt.programs.mypy.directories.<name>.extraPythonPaths
Extra paths to add to PYTHONPATH. Paths are interpreted relative to the directory options and are added before extraPythonPackages.
Type: list of string
Default:
[ ]
Example:
[
"path/to/my/module"
]
Declared by:
perSystem.treefmt.programs.mypy.directories.<name>.modules
Modules to check
Type: list of string
Default:
[
""
]
Example:
[
"mymodule"
"tests"
]
Declared by:
perSystem.treefmt.programs.mypy.directories.<name>.options
Options to pass to mypy
Type: list of string
Default:
[ ]
Example:
[
"--ignore-missing-imports"
]
Declared by:
perSystem.treefmt.programs.nickel.enable
Whether to enable nickel.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.nickel.package
The nickel package to use.
Type: package
Default:
pkgs.nickel
Declared by:
perSystem.treefmt.programs.nickel.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.nickel.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.ncl"
"*.nickel"
]
Declared by:
perSystem.treefmt.programs.nickel.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.nimpretty.enable
Whether to enable nimpretty.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.nimpretty.package
The nim package to use.
Type: package
Default:
pkgs.nim
Declared by:
perSystem.treefmt.programs.nimpretty.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.nimpretty.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nim"
]
Declared by:
perSystem.treefmt.programs.nimpretty.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.nixf-diagnose.enable
Whether to enable nixf-diagnose.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.nixf-diagnose.package
The nixf-diagnose package to use.
Type: package
Default:
pkgs.nixf-diagnose
Declared by:
perSystem.treefmt.programs.nixf-diagnose.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.nixf-diagnose.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nix"
]
Declared by:
perSystem.treefmt.programs.nixf-diagnose.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.nixfmt.enable
Whether to enable nixfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.nixfmt.package
The nixfmt-rfc-style package to use.
Type: package
Default:
pkgs.nixfmt-rfc-style
Declared by:
perSystem.treefmt.programs.nixfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.nixfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nix"
]
Declared by:
perSystem.treefmt.programs.nixfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.nixfmt.strict
Enable a stricter formatting mode that isn’t influenced as much by how the input is formatted.
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.nixfmt.width
Maximum width in characters [default: 100]
Type: null or signed integer
Default:
null
Example:
120
Declared by:
perSystem.treefmt.programs.nixfmt-classic.enable
Whether to enable nixfmt-classic.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.nixfmt-classic.package
The nixfmt-classic package to use.
Type: package
Default:
pkgs.nixfmt-classic
Declared by:
perSystem.treefmt.programs.nixfmt-classic.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.nixfmt-classic.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nix"
]
Declared by:
perSystem.treefmt.programs.nixfmt-classic.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.nixfmt-rfc-style.enable
Whether to enable nixfmt-rfc-style.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.nixfmt-rfc-style.package
The nixfmt-rfc-style package to use.
Type: package
Default:
pkgs.nixfmt-rfc-style
Declared by:
perSystem.treefmt.programs.nixfmt-rfc-style.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.nixfmt-rfc-style.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nix"
]
Declared by:
perSystem.treefmt.programs.nixfmt-rfc-style.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.nixpkgs-fmt.enable
Whether to enable nixpkgs-fmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.nixpkgs-fmt.package
The nixpkgs-fmt package to use.
Type: package
Default:
pkgs.nixpkgs-fmt
Declared by:
perSystem.treefmt.programs.nixpkgs-fmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.nixpkgs-fmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nix"
]
Declared by:
perSystem.treefmt.programs.nixpkgs-fmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.ocamlformat.enable
Whether to enable ocamlformat.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.ocamlformat.package
The ocamlformat package to use.
Type: package
Default:
pkgs.ocamlformat
Declared by:
perSystem.treefmt.programs.ocamlformat.configFile
Path to the .ocamlformat file. Used to pick the right version of ocamlformat if passed.
Type: null or absolute path
Default:
null
Declared by:
perSystem.treefmt.programs.ocamlformat.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.ocamlformat.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.ml"
"*.mli"
]
Declared by:
perSystem.treefmt.programs.ocamlformat.pkgs
The package set used to get the ocamlformat package at a specific version.
Type: lazy attribute set of raw value
Default: Nixpkgs from context
Declared by:
perSystem.treefmt.programs.ocamlformat.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.odinfmt.enable
Whether to enable odinfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.odinfmt.package
The ols package to use.
Type: package
Default:
pkgs.ols
Declared by:
perSystem.treefmt.programs.odinfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.odinfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.odin"
]
Declared by:
perSystem.treefmt.programs.odinfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.opa.enable
Whether to enable opa.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.opa.package
The open-policy-agent package to use.
Type: package
Default:
pkgs.open-policy-agent
Declared by:
perSystem.treefmt.programs.opa.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.opa.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.rego"
]
Declared by:
perSystem.treefmt.programs.opa.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.ormolu.enable
Whether to enable ormolu.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.ormolu.package
The ormolu package to use.
Type: package
Default:
pkgs.ormolu
Declared by:
perSystem.treefmt.programs.ormolu.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.ormolu.ghcOpts
Which GHC language extensions to enable
Type: unspecified value
Default:
[
"BangPatterns"
"PatternSynonyms"
"TypeApplications"
]
Declared by:
perSystem.treefmt.programs.ormolu.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.hs"
]
Declared by:
perSystem.treefmt.programs.ormolu.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.oxipng.enable
Whether to enable oxipng.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.oxipng.package
The oxipng package to use.
Type: package
Default:
pkgs.oxipng
Declared by:
perSystem.treefmt.programs.oxipng.alpha
Whether to enable Perform additional optimization on images with an alpha channel.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.oxipng.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.oxipng.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.png"
]
Declared by:
perSystem.treefmt.programs.oxipng.opt
Set the optimization level preset
Type: string
Default:
"2"
Example:
"max"
Declared by:
perSystem.treefmt.programs.oxipng.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.oxipng.scale16
Whether to enable Forcibly reduce images with 16 bits per channel to 8 bits per channel.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.oxipng.strip
Strip metadata chunks
Type: null or string
Default:
null
Example:
"safe"
Declared by:
perSystem.treefmt.programs.packer.enable
Whether to enable packer.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.packer.package
The packer package to use.
Type: package
Default:
pkgs.packer
Declared by:
perSystem.treefmt.programs.packer.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.packer.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.pkr.hcl"
"*.pkrvars.hcl"
]
Declared by:
perSystem.treefmt.programs.packer.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.perltidy.enable
Whether to enable perltidy.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.perltidy.package
The PerlTidy package to use.
Type: package
Default:
pkgs.perlPackages.PerlTidy
Declared by:
perSystem.treefmt.programs.perltidy.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.perltidy.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.pl"
]
Declared by:
perSystem.treefmt.programs.perltidy.perltidyrc
A path for perltidy’s configuration file, usually named .perltidyrc
Type: null or absolute path
Default:
null
Declared by:
perSystem.treefmt.programs.perltidy.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.php-cs-fixer.enable
Whether to enable php-cs-fixer.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.php-cs-fixer.package
The php-cs-fixer package to use.
Type: package
Default:
pkgs.php83Packages.php-cs-fixer
Declared by:
perSystem.treefmt.programs.php-cs-fixer.configFile
Path to php-cs-fixer config file.
Type: string or absolute path
Default:
"./.php-cs-fixer.php"
Example:
"./.php-cs-fixer.dist.php"
Declared by:
perSystem.treefmt.programs.php-cs-fixer.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.php-cs-fixer.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.php"
]
Declared by:
perSystem.treefmt.programs.php-cs-fixer.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.pinact.enable
Whether to enable pinact.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.pinact.package
The pinact package to use.
Type: package
Default:
pkgs.pinact
Declared by:
perSystem.treefmt.programs.pinact.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.pinact.includes
Path / file patterns to include
Type: list of string
Default:
[
".github/workflows/*.yml"
".github/workflows/*.yaml"
"**/action.yml"
"**/action.yaml"
]
Declared by:
perSystem.treefmt.programs.pinact.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.pinact.settings
Configuration for pinact, see <link xlink:href=“https://github.com/suzuki-shunsuke/pinact?tab=readme-ov-file#configuration”/> for supported values.
Type: YAML 1.1 value
Default:
{ }
Declared by:
perSystem.treefmt.programs.pinact.update
Update actions to latest versions.
Type: boolean
Default:
true
Declared by:
perSystem.treefmt.programs.pinact.verify
Verify if pairs of commit SHA and version are correct.
Type: boolean
Default:
true
Declared by:
perSystem.treefmt.programs.prettier.enable
Whether to enable prettier.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.prettier.package
The prettier package to use.
Type: package
Default:
pkgs.nodePackages.prettier
Declared by:
perSystem.treefmt.programs.prettier.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.prettier.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.cjs"
"*.css"
"*.html"
"*.js"
"*.json"
"*.json5"
"*.jsx"
"*.md"
"*.mdx"
"*.mjs"
"*.scss"
"*.ts"
"*.tsx"
"*.vue"
"*.yaml"
"*.yml"
]
Declared by:
perSystem.treefmt.programs.prettier.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.prettier.settings.arrowParens
Include parentheses around a sole arrow function parameter.
Type: null or one of “always”, “avoid”
Default:
null
Example:
"always"
Declared by:
perSystem.treefmt.programs.prettier.settings.bracketSameLine
Put > of opening tags on the last line instead of on a new line.
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.bracketSpacing
Print spaces between brackets
Type: null or boolean
Default:
null
Example:
true
Declared by:
perSystem.treefmt.programs.prettier.settings.cursorOffset
Print (to stderr) where a cursor at the given position would move to after formatting. This option cannot be used with --range-start and –range-end.
Type: null or signed integer
Default:
null
Example:
-1
Declared by:
perSystem.treefmt.programs.prettier.settings.editorconfig
Whether parse the .editorconfig file in your project and convert its properties to the corresponding Prettier configuration. This configuration will be overridden by .prettierrc, etc.
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.embeddedLanguageFormatting
Control how Prettier formats quoted code embedded in the file.
Type: null or one of “auto”, “off”
Default:
null
Example:
"auto"
Declared by:
perSystem.treefmt.programs.prettier.settings.endOfLine
Which end of line characters to apply.
Type: null or one of “lf”, “crlf”, “cr”, “auto”
Default:
null
Example:
"lf"
Declared by:
perSystem.treefmt.programs.prettier.settings.filepath
Specify the input filepath. This will be used to do parser inference.
Type: null or string
Default:
null
Example:
"example.js"
Declared by:
perSystem.treefmt.programs.prettier.settings.htmlWhitespaceSensitivity
How to handle whitespaces in HTML.
Type: null or one of “css”, “strict”, “ignore”
Default:
null
Example:
"css"
Declared by:
perSystem.treefmt.programs.prettier.settings.insertPragma
Insert @format pragma into file’s first docblock commentypes.
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.jsxSingleQuote
Use single quotes in JSX
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.overrides
Provide a list of patterns to override prettier configuration.
Type: null or (list of (attribute set))
Default:
null
Example:
{
files = [
"*.html"
"legacy/**/*.js"
];
options = {
tabwidth = 4;
};
}
Declared by:
perSystem.treefmt.programs.prettier.settings.parser
Which parser to use.
Type: null or one of “flow”, “babel”, “babel-flow”, “babel-ts”, “typescript”, “acorn”, “espree”, “meriyah”, “css”, “less”, “scss”, “json”, “json5”, “json-stringify”, “graphql”, “markdown”, “mdx”, “vue”, “yaml”, “glimmer”, “html”, “angular”, “lwc” or string
Default:
null
Example:
"typescript"
Declared by:
perSystem.treefmt.programs.prettier.settings.pluginSearchDirs
Custom directory that contains prettier plugins in node_modules subdirectory. Overrides default behavior when plugins are searched relatively to the location of Prettier.\nMultiple values are accepted.
Type: null or (list of string) or value false (singular enum)
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.plugins
Add a plugin. Multiple plugins can be passed as separate --plugins.
Type: null or (list of string)
Default:
null
Example:
[
"@prettier/plugin-xml"
]
Declared by:
perSystem.treefmt.programs.prettier.settings.printWidth
The line length where Prettier will try wrap.
Type: null or signed integer
Default:
null
Example:
80
Declared by:
perSystem.treefmt.programs.prettier.settings.proseWrap
How to wrap prose.
Type: null or one of “always”, “never”, “preserve”
Default:
null
Example:
"preserve"
Declared by:
perSystem.treefmt.programs.prettier.settings.quoteProps
Change when properties in objects are quoted
Type: null or one of “as-needed”, “consistent”, “preserve”
Default:
null
Example:
"as-needed"
Declared by:
perSystem.treefmt.programs.prettier.settings.rangeEnd
Format code ending at a given character offset (exclusive). The range will extend forwards to the end of the selected statementypes. This option cannot be used with --cursor-offsetypes.
Type: null or string
Default:
null
Example:
0
Declared by:
perSystem.treefmt.programs.prettier.settings.rangeStart
Format code starting at a given character offsetypes. The range will extend backwards to the start of the first line containing the selected statementypes. his option cannot be used with --cursor-offsetypes.
Type: null or signed integer
Default:
null
Example:
0
Declared by:
perSystem.treefmt.programs.prettier.settings.requirePragma
Require either ‘@prettier’ or ‘@format’ to be present in the file’s first docblock comment\nin order for it to be formatted.
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.semi
Print semicolons.
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.singleAttributePerLine
Enforce single attribute per line in HTML, Vue and JSX.
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.singleQuote
Use single quotes instead of double quotes.
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.tabWidth
Number of spaces per indentation level.
Type: null or signed integer
Default:
null
Example:
2
Declared by:
perSystem.treefmt.programs.prettier.settings.trailingComma
Print trailing commas wherever possible when multi-line.
Type: null or one of “es5”, “none”, “all”
Default:
null
Example:
"es5"
Declared by:
perSystem.treefmt.programs.prettier.settings.useTabs
Indent with tabs instead of spaces
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.prettier.settings.vueIndentScriptAndStyle
Indent script and style tags in Vue files.
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.protolint.enable
Whether to enable protolint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.protolint.package
The protolint package to use.
Type: package
Default:
pkgs.protolint
Declared by:
perSystem.treefmt.programs.protolint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.protolint.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.proto"
]
Declared by:
perSystem.treefmt.programs.protolint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.purs-tidy.enable
Whether to enable purs-tidy.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.purs-tidy.package
The purs-tidy package to use.
Type: package
Default:
pkgs.nodePackages.purs-tidy
Declared by:
perSystem.treefmt.programs.purs-tidy.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.purs-tidy.includes
Path / file patterns to include
Type: list of string
Default:
[
"src/**/*.purs"
"test/**/*.purs"
]
Declared by:
perSystem.treefmt.programs.purs-tidy.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.rstfmt.enable
Whether to enable rstfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.rstfmt.package
The rstfmt package to use.
Type: package
Default:
pkgs.rstfmt
Declared by:
perSystem.treefmt.programs.rstfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.rstfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.rst"
"*.txt"
]
Declared by:
perSystem.treefmt.programs.rstfmt.line_length
Sets the line length.
Type: signed integer
Default:
72
Example:
80
Declared by:
perSystem.treefmt.programs.rstfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.rubocop.enable
Whether to enable rubocop.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.rubocop.package
The rubocop package to use.
Type: package
Default:
pkgs.rubocop
Declared by:
perSystem.treefmt.programs.rubocop.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.rubocop.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.rb"
]
Declared by:
perSystem.treefmt.programs.rubocop.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.ruff-check.enable
Whether to enable ruff-check.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.ruff-check.package
The ruff package to use.
Type: package
Default:
pkgs.ruff
Declared by:
perSystem.treefmt.programs.ruff-check.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.ruff-check.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.py"
"*.pyi"
]
Declared by:
perSystem.treefmt.programs.ruff-check.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.ruff-format.enable
Whether to enable ruff-format.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.ruff-format.package
The ruff package to use.
Type: package
Default:
pkgs.ruff
Declared by:
perSystem.treefmt.programs.ruff-format.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.ruff-format.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.py"
"*.pyi"
]
Declared by:
perSystem.treefmt.programs.ruff-format.lineLength
Set the line-length.
Type: null or signed integer
Default:
null
Example:
79
Declared by:
perSystem.treefmt.programs.ruff-format.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.rufo.enable
Whether to enable rufo.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.rufo.package
The rufo package to use.
Type: package
Default:
pkgs.rufo
Declared by:
perSystem.treefmt.programs.rufo.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.rufo.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.rb"
]
Declared by:
perSystem.treefmt.programs.rufo.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.rustfmt.enable
Whether to enable rustfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.rustfmt.package
The rustfmt package to use.
Type: package
Default:
pkgs.rustfmt
Declared by:
perSystem.treefmt.programs.rustfmt.edition
Rust edition to target when formatting
Type: string
Default:
"2024"
Declared by:
perSystem.treefmt.programs.rustfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.rustfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.rs"
]
Declared by:
perSystem.treefmt.programs.rustfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.scalafmt.enable
Whether to enable scalafmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.scalafmt.package
The scalafmt package to use.
Type: package
Default:
pkgs.scalafmt
Declared by:
perSystem.treefmt.programs.scalafmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.scalafmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.sbt"
"*.scala"
]
Declared by:
perSystem.treefmt.programs.scalafmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.shellcheck.enable
Whether to enable shellcheck.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.shellcheck.package
The shellcheck package to use.
Type: package
Default:
pkgs.shellcheck
Declared by:
perSystem.treefmt.programs.shellcheck.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.shellcheck.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.sh"
"*.bash"
"*.envrc"
"*.envrc.*"
]
Declared by:
perSystem.treefmt.programs.shellcheck.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.shfmt.enable
Whether to enable shfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.shfmt.package
The shfmt package to use.
Type: package
Default:
pkgs.shfmt
Declared by:
perSystem.treefmt.programs.shfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.shfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.sh"
"*.bash"
"*.envrc"
"*.envrc.*"
]
Declared by:
perSystem.treefmt.programs.shfmt.indent_size
Sets the number of spaces to be used in indentation. Uses tabs if set to zero. If this is null, then .editorconfig will be used to configure shfmt.
Type: null or signed integer
Default:
2
Example:
4
Declared by:
perSystem.treefmt.programs.shfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.sql-formatter.enable
Whether to enable sql-formatter.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.sql-formatter.package
The sql-formatter package to use.
Type: package
Default:
pkgs.sql-formatter
Declared by:
perSystem.treefmt.programs.sql-formatter.dialect
The sql dialect to use for formatting
Type: null or one of “bigquery”, “db2”, “db2i”, “hive”, “mariadb”, “mysql”, “n1ql”, “plsql”, “postgresql”, “redshift”, “spark”, “sqlite”, “sql”, “tidb”, “trino”, “transactsql”, “tsql”, “singlestoredb”, “snowflake”
Default:
null
Example:
"postgresql"
Declared by:
perSystem.treefmt.programs.sql-formatter.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.sql-formatter.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.sql"
]
Declared by:
perSystem.treefmt.programs.sql-formatter.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.sqlfluff.enable
Whether to enable sqlfluff.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.sqlfluff.package
The sqlfluff package to use.
Type: package
Default:
pkgs.sqlfluff
Declared by:
perSystem.treefmt.programs.sqlfluff.dialect
The sql dialect to use for formatting
Type: null or one of “db2”, “ansi”, “soql”, “tsql”, “hive”, “trino”, “mysql”, “oracle”, “sqlite”, “duckdb”, “exasol”, “athena”, “mariadb”, “vertica”, “teradata”, “redshift”, “sparksql”, “bigquery”, “postgres”, “greenplum”, “snowflake”, “materializ”, “clickhouse”, “databricks”
Default:
null
Example:
"sqlite"
Declared by:
perSystem.treefmt.programs.sqlfluff.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.sqlfluff.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.sql"
]
Declared by:
perSystem.treefmt.programs.sqlfluff.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.sqlfluff-lint.enable
Whether to enable sqlfluff-lint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.sqlfluff-lint.package
The sqlfluff package to use.
Type: package
Default:
pkgs.sqlfluff
Declared by:
perSystem.treefmt.programs.sqlfluff-lint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.sqlfluff-lint.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.sql"
]
Declared by:
perSystem.treefmt.programs.sqlfluff-lint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.sqruff.enable
Whether to enable sqruff.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.sqruff.package
The sqruff package to use.
Type: package
Default:
pkgs.sqruff
Declared by:
perSystem.treefmt.programs.sqruff.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.sqruff.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.sql"
]
Declared by:
perSystem.treefmt.programs.sqruff.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.statix.enable
Whether to enable statix.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.statix.package
The statix package to use.
Type: package
Default:
pkgs.statix
Declared by:
perSystem.treefmt.programs.statix.disabled-lints
List of ignored lints. Run statix list to see all available lints.
Type: list of string
Default:
[ ]
Example:
[
"empty_pattern"
]
Declared by:
perSystem.treefmt.programs.statix.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.statix.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.nix"
]
Declared by:
perSystem.treefmt.programs.statix.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.stylish-haskell.enable
Whether to enable stylish-haskell.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.stylish-haskell.package
The stylish-haskell package to use.
Type: package
Default:
pkgs.stylish-haskell
Declared by:
perSystem.treefmt.programs.stylish-haskell.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.stylish-haskell.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.hs"
]
Declared by:
perSystem.treefmt.programs.stylish-haskell.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.stylua.enable
Whether to enable stylua.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.stylua.package
The stylua package to use.
Type: package
Default:
pkgs.stylua
Declared by:
perSystem.treefmt.programs.stylua.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.stylua.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.lua"
]
Declared by:
perSystem.treefmt.programs.stylua.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.stylua.settings.call_parentheses
Whether parentheses should be applied on
function calls with a single string/table
argument. Always applies parentheses in
all cases. NoSingleString omits
parentheses on calls with a single string
argument. Similarly, NoSingleTable omits
parentheses on calls with a single table
argument. None omits parentheses in both
cases.
Note: parentheses are still kept in situations
where removal can lead to obscurity
(e.g. foo "bar".setup -> foo("bar").setup,
since the index is on the call result, not the string).
Input removes all automation and preserves
parentheses only if they were present in input code:
consistency is not enforced.
Type: null or one of “Always”, “NoSingleString”, “NoSingleTable”, “None”, “Input”
Default:
null
Example:
"Always"
Declared by:
perSystem.treefmt.programs.stylua.settings.collapse_simple_statement
Specify whether to collapse simple statements.
Type: null or one of “Never”, “FunctionOnly”, “ConditionalOnly”, “Always”
Default:
null
Example:
"Never"
Declared by:
perSystem.treefmt.programs.stylua.settings.column_width
Approximate line length for printing.
Used as a guide for line wrapping - this is not a hard requirement: lines may fall under or over the limit.
Type: null or signed integer
Default:
null
Example:
120
Declared by:
perSystem.treefmt.programs.stylua.settings.indent_type
Indent type.
Type: null or one of “Tabs”, “Spaces”
Default:
null
Example:
"Tabs"
Declared by:
perSystem.treefmt.programs.stylua.settings.indent_width
Character size of single indentation.
If indent_type is set to Tabs,
this option is used as a heuristic to
determine column width only.
Type: null or signed integer
Default:
null
Example:
4
Declared by:
perSystem.treefmt.programs.stylua.settings.line_endings
Line endings type.
Type: null or one of “Unix”, “Windows”
Default:
null
Example:
"Unix"
Declared by:
perSystem.treefmt.programs.stylua.settings.quote_style
Quote style for string literals.
AutoPrefer styles will prefer the
specified quote style, but fall back to
the alternative if it has fewer string
escapes. Force styles always use the
specified style regardless of escapes.
Type: null or one of “AutoPreferDouble”, “AutoPreferSingle”, “ForceDouble”, “ForceSingle”
Default:
null
Example:
"AutoPreferDouble"
Declared by:
perSystem.treefmt.programs.stylua.settings.sort_requires.enabled
StyLua has built-in support for sorting require statements. We group consecutive require statements into a single “block”, and then requires are sorted only within that block. Blocks of requires do not move around the file.
We only include requires of the form
local NAME = require(EXPR), and sort
lexicographically based on NAME.
(We also sort Roblox services of the form
local NAME = game:GetService(EXPR))
Type: null or boolean
Default:
null
Example:
false
Declared by:
perSystem.treefmt.programs.swift-format.enable
Whether to enable swift-format.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.swift-format.package
The swift-format package to use.
Type: package
Default:
pkgs.swift-format
Declared by:
perSystem.treefmt.programs.swift-format.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.swift-format.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.swift"
]
Declared by:
perSystem.treefmt.programs.swift-format.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.taplo.enable
Whether to enable taplo.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.taplo.package
The taplo package to use.
Type: package
Default:
pkgs.taplo
Declared by:
perSystem.treefmt.programs.taplo.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.taplo.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.toml"
]
Declared by:
perSystem.treefmt.programs.taplo.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.taplo.settings
Configuration to generate taplo.toml with
Type: TOML value
Default:
{ }
Declared by:
perSystem.treefmt.programs.templ.enable
Whether to enable templ.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.templ.package
The templ package to use.
Type: package
Default:
pkgs.templ
Declared by:
perSystem.treefmt.programs.templ.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.templ.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.templ"
]
Declared by:
perSystem.treefmt.programs.templ.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.terraform.enable
Whether to enable terraform.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.terraform.package
The opentofu package to use.
Type: package
Default:
pkgs.opentofu
Declared by:
perSystem.treefmt.programs.terraform.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.terraform.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.tf"
"*.tfvars"
"*.tftest.hcl"
]
Declared by:
perSystem.treefmt.programs.terraform.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.texfmt.enable
Whether to enable texfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.texfmt.package
The tex-fmt package to use.
Type: package
Default:
pkgs.tex-fmt
Declared by:
perSystem.treefmt.programs.texfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.texfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.tex"
"*.sty"
"*.cls"
"*.bib"
"*.cmh"
]
Declared by:
perSystem.treefmt.programs.texfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.toml-sort.enable
Whether to enable toml-sort.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.toml-sort.package
The toml-sort package to use.
Type: package
Default:
pkgs.toml-sort
Declared by:
perSystem.treefmt.programs.toml-sort.all
Whether to enable sort ALL keys.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.toml-sort.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.toml-sort.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.toml"
]
Declared by:
perSystem.treefmt.programs.toml-sort.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.typos.enable
Whether to enable typos.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.typos.package
The typos package to use.
Type: package
Default:
pkgs.typos
Declared by:
perSystem.treefmt.programs.typos.binary
Search binary files
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.configFile
Custom config file
Type: null or string
Default:
null
Example:
"typos.toml"
Declared by:
perSystem.treefmt.programs.typos.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.typos.hidden
Search hidden files and directories
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.includes
Path / file patterns to include
Type: list of string
Default:
[
"*"
]
Declared by:
perSystem.treefmt.programs.typos.isolated
Ignore implicit configuration files
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.locale
Language locale to suggest corrections for [possible values: en, en-us, en-gb, en-ca, en-au]
Type: null or one of “en”, “en-us”, “en-gb”, “en-ca”, “en-au”
Default:
null
Declared by:
perSystem.treefmt.programs.typos.noCheckFilenames
Skip verifying spelling in file names
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.noCheckFiles
Skip verifying spelling in files
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.noIgnore
Don’t respect ignore files
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.noIgnoreDot
Don’t respect .ignore files
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.noIgnoreGlobal
Don’t respect global ignore files
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.noIgnoreParent
Don’t respect ignore files in parent directories
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.noIgnoreVCS
Don’t respect ignore files in vsc directories
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.noUnicode
Only allow ASCII characters in identifiers
Type: boolean
Default:
false
Declared by:
perSystem.treefmt.programs.typos.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.typos.sort
Sort results
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.typos.threads
The approximate number of threads to use [default: 0]
Type: null or signed integer
Default:
null
Example:
2
Declared by:
perSystem.treefmt.programs.typstfmt.enable
Whether to enable typstfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.typstfmt.package
The typstfmt package to use.
Type: package
Default:
pkgs.typstfmt
Declared by:
perSystem.treefmt.programs.typstfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.typstfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.typ"
"*.typst"
]
Declared by:
perSystem.treefmt.programs.typstfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.typstyle.enable
Whether to enable typstyle.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.typstyle.package
The typstyle package to use.
Type: package
Default:
pkgs.typstyle
Declared by:
perSystem.treefmt.programs.typstyle.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.typstyle.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.typ"
"*.typst"
]
Declared by:
perSystem.treefmt.programs.typstyle.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.xmllint.enable
Whether to enable xmllint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.xmllint.package
The libxml2 package to use.
Type: package
Default:
pkgs.libxml2
Declared by:
perSystem.treefmt.programs.xmllint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.xmllint.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.xml"
"*.svg"
"*.xhtml"
"*.xsl"
"*.xslt"
"*.dtd"
"*.xsd"
]
Declared by:
perSystem.treefmt.programs.xmllint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.yamlfmt.enable
Whether to enable yamlfmt.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.yamlfmt.package
The yamlfmt package to use.
Type: package
Default:
pkgs.yamlfmt
Declared by:
perSystem.treefmt.programs.yamlfmt.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.yamlfmt.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.yaml"
"*.yml"
]
Declared by:
perSystem.treefmt.programs.yamlfmt.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.yamlfmt.settings
Configuration for yamlfmt, see <link xlink:href=“https://github.com/google/yamlfmt/blob/main/docs/config-file.md”/> for supported values.
Type: YAML 1.1 value
Default:
{ }
Declared by:
perSystem.treefmt.programs.zig.enable
Whether to enable zig.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.zig.package
The zig package to use.
Type: package
Default:
pkgs.zig
Declared by:
perSystem.treefmt.programs.zig.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.zig.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.zig"
"*.zon"
]
Declared by:
perSystem.treefmt.programs.zig.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.zizmor.enable
Whether to enable zizmor.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.zizmor.package
The zizmor package to use.
Type: package
Default:
pkgs.zizmor
Declared by:
perSystem.treefmt.programs.zizmor.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.zizmor.includes
Path / file patterns to include
Type: list of string
Default:
[
".github/workflows/*.yml"
".github/workflows/*.yaml"
]
Declared by:
perSystem.treefmt.programs.zizmor.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.zprint.enable
Whether to enable zprint.
Type: boolean
Default:
false
Example:
true
Declared by:
perSystem.treefmt.programs.zprint.package
The zprint package to use.
Type: package
Default:
pkgs.zprint
Declared by:
perSystem.treefmt.programs.zprint.excludes
Path / file patterns to exclude
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.programs.zprint.includes
Path / file patterns to include
Type: list of string
Default:
[
"*.clj"
"*.cljc"
"*.cljs"
"*.edn"
]
Declared by:
perSystem.treefmt.programs.zprint.priority
Priority
Type: null or signed integer
Default:
null
Declared by:
perSystem.treefmt.programs.zprint.zprintOpts
Clojure map containing zprint options.
Type: null or string
Default:
null
Example:
"{:width 90}"
Declared by:
perSystem.treefmt.projectRoot
Path to the root of the project on which treefmt operates
Type: absolute path
Default:
self
Declared by:
perSystem.treefmt.projectRootFile
File to look for to determine the root of the project in the build.wrapper.
Type: string
Default:
".git/config"
Declared by:
perSystem.treefmt.settings
The contents of treefmt.toml
Type: TOML value
Default:
{ }
Declared by:
perSystem.treefmt.settings.formatter
Set of formatters to use
Type: attribute set of (TOML value)
Default:
{ }
Declared by:
perSystem.treefmt.settings.formatter.<name>.command
Executable obeying the treefmt formatter spec
Type: Path to executable
Declared by:
perSystem.treefmt.settings.formatter.<name>.excludes
List of files to exclude for formatting. Supports globbing. Takes precedence over the includes.
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.settings.formatter.<name>.includes
List of files to include for formatting. Supports globbing.
Type: list of string
Declared by:
perSystem.treefmt.settings.formatter.<name>.options
List of arguments to pass to the command
Type: list of string
Default:
[ ]
Declared by:
perSystem.treefmt.settings.global.excludes
A global list of paths to exclude. Supports glob.
Type: list of string
Default:
[ ]
Example:
[
"node_modules/*"
]
Declared by:
perSystem.treefmt.settings.global.on-unmatched
Log paths that did not match any formatters at the specified log level.
Type: one of “debug”, “info”, “warn”, “error”, “fatal”
Default:
"warn"
Declared by: