Shell module treefmt

treefmt¶

treefmt config

Type: submodule

Default:

{ }

Declared by: - templates/nix-shell-parts-vendored/nix/vendored/shell-modules/treefmt.nix

treefmt.enable¶

Whether to enable treefmt formatting.

Type: boolean

Default:

false

Example:

true

Declared by: - templates/nix-shell-parts-vendored/nix/vendored/shell-modules/treefmt.nix

treefmt.enableDefaultExcludes¶

Enable the default excludes in the treefmt configuration.

Type: boolean

Default:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/module-options.nix

treefmt.package¶

The treefmt package to use.

Type: package

Default:

pkgs.treefmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/module-options.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/module-options.nix

treefmt.build.configFile¶

Contains the generated config file derived from the settings.

Type: absolute path

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/module-options.nix

treefmt.build.devShell¶

The development shell with treefmt and its underlying programs

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/module-options.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/module-options.nix

treefmt.build.wrapper¶

The treefmt package, wrapped with the config file.

Type: package

Default: wrapped treefmt command

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/module-options.nix

treefmt.pre-commit-hook¶

Whether to enable Setup pre commit hook for treefmt.

Type: boolean

Default:

false

Example:

true

Declared by: - templates/nix-shell-parts-vendored/nix/vendored/shell-modules/treefmt.nix

treefmt.programs.actionlint.enable¶

Whether to enable actionlint.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/actionlint.nix

treefmt.programs.actionlint.package¶

The actionlint package to use.

Type: package

Default:

pkgs.actionlint

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/actionlint.nix

treefmt.programs.actionlint.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/actionlint.nix

treefmt.programs.actionlint.finalPackage¶

Resulting actionlint package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/actionlint.nix

treefmt.programs.actionlint.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  ".github/workflows/*.yml"
  ".github/workflows/*.yaml"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/actionlint.nix

treefmt.programs.actionlint.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/actionlint.nix

treefmt.programs.aiken.enable¶

Whether to enable aiken.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/aiken.nix

treefmt.programs.aiken.package¶

The aiken package to use.

Type: package

Default:

pkgs.aiken

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/aiken.nix

treefmt.programs.aiken.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/aiken.nix

treefmt.programs.aiken.finalPackage¶

Resulting aiken package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/aiken.nix

treefmt.programs.aiken.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.ak"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/aiken.nix

treefmt.programs.aiken.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/aiken.nix

treefmt.programs.alejandra.enable¶

Whether to enable alejandra.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/alejandra.nix

treefmt.programs.alejandra.package¶

The alejandra package to use.

Type: package

Default:

pkgs.alejandra

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/alejandra.nix

treefmt.programs.alejandra.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/alejandra.nix

treefmt.programs.alejandra.finalPackage¶

Resulting alejandra package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/alejandra.nix

treefmt.programs.alejandra.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.nix"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/alejandra.nix

treefmt.programs.alejandra.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/alejandra.nix

treefmt.programs.asmfmt.enable¶

Whether to enable asmfmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/asmfmt.nix

treefmt.programs.asmfmt.package¶

The asmfmt package to use.

Type: package

Default:

pkgs.asmfmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/asmfmt.nix

treefmt.programs.asmfmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/asmfmt.nix

treefmt.programs.asmfmt.finalPackage¶

Resulting asmfmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/asmfmt.nix

treefmt.programs.asmfmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.s"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/asmfmt.nix

treefmt.programs.asmfmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/asmfmt.nix

treefmt.programs.autocorrect.enable¶

Whether to enable autocorrect.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.package¶

The autocorrect package to use.

Type: package

Default:

pkgs.autocorrect

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.finalPackage¶

Resulting autocorrect package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.settings.context¶

Enable or disable in a specific context.

Type: null or (submodule)

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.settings.rules¶

Configure rules for autocorrect formatting.

Type: null or (submodule)

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.settings.rules.fullwidth¶

Convert to fullwidth.

Type: null or one of “off”, “error”, “warning”

Default:

null

Example:

"error"

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.settings.rules.spellcheck¶

Spellcheck.

Type: null or one of “off”, “error”, “warning”

Default:

null

Example:

"warning"

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.autocorrect.settings.spellcheck¶

Spellcheck configuration.

Type: null or (submodule)

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/autocorrect.nix

treefmt.programs.beautysh.enable¶

Whether to enable beautysh.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/beautysh.nix

treefmt.programs.beautysh.package¶

The beautysh package to use.

Type: package

Default:

pkgs.beautysh

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/beautysh.nix

treefmt.programs.beautysh.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/beautysh.nix

treefmt.programs.beautysh.finalPackage¶

Resulting beautysh package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/beautysh.nix

treefmt.programs.beautysh.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.sh"
  "*.bash"
  "*.envrc"
  "*.envrc.*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/beautysh.nix

treefmt.programs.beautysh.indent_size¶

Sets the number of spaces to be used in indentation.

Type: signed integer

Default:

2

Example:

4

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/beautysh.nix

treefmt.programs.beautysh.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/beautysh.nix

treefmt.programs.biome.enable¶

Whether to enable biome.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.package¶

The biome package to use.

Type: package

Default:

pkgs.biome

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.finalPackage¶

Resulting biome package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.formatCommand¶

The command to run Biome with.

Type: one of “format”, “lint”, “check”

Default:

"check"

Example:

"format"

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.formatUnsafe¶

Allows to format a document that has unsafe fixes.

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.settings¶

Raw Biome configuration (must conform to Biome JSON schema)

Type: JSON value

Default:

{ }

Example:

{
  formatter = {
    indentStyle = "space";
    lineWidth = 100;
  };
  javascript = {
    formatter = {
      lineWidth = 120;
      quoteStyle = "single";
    };
  };
  json = {
    formatter = {
      enabled = false;
    };
  };
}

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.validate.enable¶

Whether to validate treefmt.programs.biome.settings.

Type: boolean

Default:

true

Example:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.biome.validate.schema¶

The biome schema file to validate against

Type: absolute path

Default: Fetches "https://biomejs.dev/schemas/${biomeVersion}/schema.json" using pkgs.fetchurl.

Example:

pkgs.fetchurl {
  url = "https://biomejs.dev/schemas/2.1.2/schema.json"
  hash = "sha256-n4Y16J7g34e0VdQzRItu/P7n5oppkY4Vm4P1pQxOILU=";
}

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/biome.nix

treefmt.programs.black.enable¶

Whether to enable black.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/black.nix

treefmt.programs.black.package¶

The black package to use.

Type: package

Default:

pkgs.black

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/black.nix

treefmt.programs.black.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/black.nix

treefmt.programs.black.finalPackage¶

Resulting black package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/black.nix

treefmt.programs.black.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.py"
  "*.pyi"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/black.nix

treefmt.programs.black.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/black.nix

treefmt.programs.buf.enable¶

Whether to enable buf.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buf.nix

treefmt.programs.buf.package¶

The buf package to use.

Type: package

Default:

pkgs.buf

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buf.nix

treefmt.programs.buf.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buf.nix

treefmt.programs.buf.finalPackage¶

Resulting buf package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buf.nix

treefmt.programs.buf.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.proto"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buf.nix

treefmt.programs.buf.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buf.nix

treefmt.programs.buildifier.enable¶

Whether to enable buildifier.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buildifier.nix

treefmt.programs.buildifier.package¶

The buildifier package to use.

Type: package

Default:

pkgs.buildifier

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buildifier.nix

treefmt.programs.buildifier.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buildifier.nix

treefmt.programs.buildifier.finalPackage¶

Resulting buildifier package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buildifier.nix

treefmt.programs.buildifier.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.bazel"
  "*.bzl"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buildifier.nix

treefmt.programs.buildifier.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/buildifier.nix

treefmt.programs.cabal-fmt.enable¶

Whether to enable cabal-fmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-fmt.nix

treefmt.programs.cabal-fmt.package¶

The cabal-fmt package to use.

Type: package

Default:

pkgs.haskellPackages.cabal-fmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-fmt.nix

treefmt.programs.cabal-fmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-fmt.nix

treefmt.programs.cabal-fmt.finalPackage¶

Resulting cabal-fmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-fmt.nix

treefmt.programs.cabal-fmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.cabal"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-fmt.nix

treefmt.programs.cabal-fmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-fmt.nix

treefmt.programs.cabal-gild.enable¶

Whether to enable cabal-gild.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-gild.nix

treefmt.programs.cabal-gild.package¶

The cabal-gild package to use.

Type: package

Default:

pkgs.haskellPackages.cabal-gild

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-gild.nix

treefmt.programs.cabal-gild.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-gild.nix

treefmt.programs.cabal-gild.finalPackage¶

Resulting cabal-gild package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-gild.nix

treefmt.programs.cabal-gild.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.cabal"
  "cabal.project"
  "cabal.project.local"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-gild.nix

treefmt.programs.cabal-gild.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cabal-gild.nix

treefmt.programs.clang-format.enable¶

Whether to enable clang-format.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-format.nix

treefmt.programs.clang-format.package¶

The clang-tools package to use.

Type: package

Default:

pkgs.clang-tools

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-format.nix

treefmt.programs.clang-format.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-format.nix

treefmt.programs.clang-format.finalPackage¶

Resulting clang-format package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-format.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-format.nix

treefmt.programs.clang-format.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-format.nix

treefmt.programs.clang-tidy.enable¶

Whether to enable clang-tidy.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.clang-tidy.package¶

The clang-tools package to use.

Type: package

Default:

pkgs.clang-tools

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.clang-tidy.compileCommandsPath¶

used to read a compile command database

Type: null or absolute path or string

Default:

null

Example:

"/my/cmake/build/directory"

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.clang-tidy.configFile¶

Specify the path of .clang-tidy or custom config file

Type: null or absolute path

Default:

null

Example:

"/some/path/myTidyConfigFile"

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.clang-tidy.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.clang-tidy.finalPackage¶

Resulting clang-tidy package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.clang-tidy.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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.clang-tidy.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.clang-tidy.quiet¶

Run clang-tidy in quiet mode

Type: boolean

Default:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/clang-tidy.nix

treefmt.programs.cljfmt.enable¶

Whether to enable cljfmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cljfmt.nix

treefmt.programs.cljfmt.package¶

The cljfmt package to use.

Type: package

Default:

pkgs.cljfmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cljfmt.nix

treefmt.programs.cljfmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cljfmt.nix

treefmt.programs.cljfmt.finalPackage¶

Resulting cljfmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cljfmt.nix

treefmt.programs.cljfmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.clj"
  "*.cljc"
  "*.cljs"
  "*.cljx"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cljfmt.nix

treefmt.programs.cljfmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cljfmt.nix

treefmt.programs.cmake-format.enable¶

Whether to enable cmake-format.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cmake-format.nix

treefmt.programs.cmake-format.package¶

The cmake-format package to use.

Type: package

Default:

pkgs.cmake-format

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cmake-format.nix

treefmt.programs.cmake-format.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cmake-format.nix

treefmt.programs.cmake-format.finalPackage¶

Resulting cmake-format package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cmake-format.nix

treefmt.programs.cmake-format.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.cmake"
  "CMakeLists.txt"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cmake-format.nix

treefmt.programs.cmake-format.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cmake-format.nix

treefmt.programs.csharpier.enable¶

Whether to enable csharpier.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/csharpier.nix

treefmt.programs.csharpier.package¶

The csharpier package to use.

Type: package

Default:

pkgs.csharpier

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/csharpier.nix

treefmt.programs.csharpier.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/csharpier.nix

treefmt.programs.csharpier.finalPackage¶

Resulting csharpier package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/csharpier.nix

treefmt.programs.csharpier.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.cs"
  "*.csproj"
  "*.slnx"
  "*.xaml"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/csharpier.nix

treefmt.programs.csharpier.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/csharpier.nix

treefmt.programs.cue.enable¶

Whether to enable cue.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cue.nix

treefmt.programs.cue.package¶

The cue package to use.

Type: package

Default:

pkgs.cue

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cue.nix

treefmt.programs.cue.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cue.nix

treefmt.programs.cue.finalPackage¶

Resulting cue package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cue.nix

treefmt.programs.cue.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.cue"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cue.nix

treefmt.programs.cue.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/cue.nix

treefmt.programs.d2.enable¶

Whether to enable d2.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/d2.nix

treefmt.programs.d2.package¶

The d2 package to use.

Type: package

Default:

pkgs.d2

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/d2.nix

treefmt.programs.d2.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/d2.nix

treefmt.programs.d2.finalPackage¶

Resulting d2 package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/d2.nix

treefmt.programs.d2.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.d2"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/d2.nix

treefmt.programs.d2.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/d2.nix

treefmt.programs.dart-format.enable¶

Whether to enable dart-format.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dart-format.nix

treefmt.programs.dart-format.package¶

The dart package to use.

Type: package

Default:

pkgs.dart

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dart-format.nix

treefmt.programs.dart-format.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dart-format.nix

treefmt.programs.dart-format.finalPackage¶

Resulting dart-format package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dart-format.nix

treefmt.programs.dart-format.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.dart"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dart-format.nix

treefmt.programs.dart-format.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dart-format.nix

treefmt.programs.deadnix.enable¶

Whether to enable deadnix.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

treefmt.programs.deadnix.package¶

The deadnix package to use.

Type: package

Default:

pkgs.deadnix

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

treefmt.programs.deadnix.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

treefmt.programs.deadnix.finalPackage¶

Resulting deadnix package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

treefmt.programs.deadnix.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.nix"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

treefmt.programs.deadnix.no-lambda-arg¶

Whether to enable Don’t check lambda parameter arguments.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

treefmt.programs.deadnix.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deadnix.nix

treefmt.programs.deno.enable¶

Whether to enable deno.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deno.nix

treefmt.programs.deno.package¶

The deno package to use.

Type: package

Default:

pkgs.deno

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deno.nix

treefmt.programs.deno.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deno.nix

treefmt.programs.deno.finalPackage¶

Resulting deno package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deno.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deno.nix

treefmt.programs.deno.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/deno.nix

treefmt.programs.detekt.enable¶

Whether to enable detekt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/detekt.nix

treefmt.programs.detekt.package¶

The detekt package to use.

Type: package

Default:

pkgs.detekt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/detekt.nix

treefmt.programs.detekt.buildUponDefaultConfig¶

Preconfigures detekt with a bunch of rules and some opinionated defaults for you. Allows additional provided configurations to override the defaults.

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/detekt.nix

treefmt.programs.detekt.configFile¶

Path to detekt configuration file

Type: null or absolute path

Default:

null

Example:

"./detekt-config.yml"

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/detekt.nix

treefmt.programs.detekt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/detekt.nix

treefmt.programs.detekt.finalPackage¶

Resulting detekt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/detekt.nix

treefmt.programs.detekt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.kt"
  "*.kts"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/detekt.nix

treefmt.programs.detekt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/detekt.nix

treefmt.programs.dfmt.enable¶

Whether to enable dfmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dfmt.nix

treefmt.programs.dfmt.package¶

The dformat package to use.

Type: package

Default:

pkgs.dformat

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dfmt.nix

treefmt.programs.dfmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dfmt.nix

treefmt.programs.dfmt.finalPackage¶

Resulting dfmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dfmt.nix

treefmt.programs.dfmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.d"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dfmt.nix

treefmt.programs.dfmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dfmt.nix

treefmt.programs.dhall.enable¶

Whether to enable dhall.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dhall.nix

treefmt.programs.dhall.package¶

The dhall package to use.

Type: package

Default:

pkgs.dhall

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dhall.nix

treefmt.programs.dhall.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dhall.nix

treefmt.programs.dhall.finalPackage¶

Resulting dhall package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dhall.nix

treefmt.programs.dhall.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.dhall"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dhall.nix

treefmt.programs.dhall.lint¶

Whether to lint in addition to formatting.

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dhall.nix

treefmt.programs.dhall.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dhall.nix

treefmt.programs.djlint.enable¶

Whether to enable djlint.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.djlint.package¶

The djlint package to use.

Type: package

Default:

pkgs.djlint

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.djlint.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.djlint.finalPackage¶

Resulting djlint package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.djlint.ignoreRules¶

Which H-rules to ignore

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.djlint.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.html"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.djlint.indent¶

Default indentation depth in spaces

Type: unsigned integer, meaning >=0

Default:

4

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.djlint.lint¶

Whether to lint in addition to formatting.

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.djlint.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/djlint.nix

treefmt.programs.dnscontrol.enable¶

Whether to enable dnscontrol.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dnscontrol.nix

treefmt.programs.dnscontrol.package¶

The dnscontrol package to use.

Type: package

Default:

pkgs.dnscontrol

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dnscontrol.nix

treefmt.programs.dnscontrol.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dnscontrol.nix

treefmt.programs.dnscontrol.finalPackage¶

Resulting dnscontrol package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dnscontrol.nix

treefmt.programs.dnscontrol.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "dnsconfig.js"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dnscontrol.nix

treefmt.programs.dnscontrol.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dnscontrol.nix

treefmt.programs.dockerfmt.enable¶

Whether to enable dockerfmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockerfmt.nix

treefmt.programs.dockerfmt.package¶

The dockerfmt package to use.

Type: package

Default:

pkgs.dockerfmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockerfmt.nix

treefmt.programs.dockerfmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockerfmt.nix

treefmt.programs.dockerfmt.finalPackage¶

Resulting dockerfmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockerfmt.nix

treefmt.programs.dockerfmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "Dockerfile"
  "*/Dockerfile"
  "*.Dockerfile"
  "Dockerfile.*"
  "*/Dockerfile.*"
  "*.dockerfile"
  "dockerfile.*"
  "*/dockerfile.*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockerfmt.nix

treefmt.programs.dockerfmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockerfmt.nix

treefmt.programs.dockfmt.enable¶

Whether to enable dockfmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockfmt.nix

treefmt.programs.dockfmt.package¶

The dockfmt package to use.

Type: package

Default:

pkgs.dockfmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockfmt.nix

treefmt.programs.dockfmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockfmt.nix

treefmt.programs.dockfmt.finalPackage¶

Resulting dockfmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockfmt.nix

treefmt.programs.dockfmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "Dockerfile"
  "*/Dockerfile"
  "*.Dockerfile"
  "Dockerfile.*"
  "*/Dockerfile.*"
  "*.dockerfile"
  "dockerfile.*"
  "*/dockerfile.*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockfmt.nix

treefmt.programs.dockfmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dockfmt.nix

treefmt.programs.dos2unix.enable¶

Whether to enable dos2unix.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dos2unix.nix

treefmt.programs.dos2unix.package¶

The dos2unix package to use.

Type: package

Default:

pkgs.dos2unix

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dos2unix.nix

treefmt.programs.dos2unix.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dos2unix.nix

treefmt.programs.dos2unix.finalPackage¶

Resulting dos2unix package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dos2unix.nix

treefmt.programs.dos2unix.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dos2unix.nix

treefmt.programs.dos2unix.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dos2unix.nix

treefmt.programs.dprint.enable¶

Whether to enable dprint.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dprint.package¶

The dprint package to use.

Type: package

Default:

pkgs.dprint

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dprint.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dprint.finalPackage¶

Resulting dprint package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dprint.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  ".*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dprint.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dprint.settings¶

Configuration to generate dprint.json with

Type: open submodule of (JSON value)

Default:

{ }

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dprint.settings.incremental¶

Whether to format files only when they change.

Type: null or boolean

Default:

null

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dprint.settings.indentWidth¶

The number of characters for an indent

Type: null or signed integer

Default:

null

Example:

2

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dprint.nix

treefmt.programs.dscanner.enable¶

Whether to enable dscanner.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dscanner.nix

treefmt.programs.dscanner.package¶

The dscanner package to use.

Type: package

Default:

pkgs.dscanner

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dscanner.nix

treefmt.programs.dscanner.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dscanner.nix

treefmt.programs.dscanner.finalPackage¶

Resulting dscanner package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dscanner.nix

treefmt.programs.dscanner.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.d"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dscanner.nix

treefmt.programs.dscanner.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/dscanner.nix

treefmt.programs.efmt.enable¶

Whether to enable efmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/efmt.nix

treefmt.programs.efmt.package¶

The efmt package to use.

Type: package

Default:

pkgs.efmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/efmt.nix

treefmt.programs.efmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/efmt.nix

treefmt.programs.efmt.finalPackage¶

Resulting efmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/efmt.nix

treefmt.programs.efmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.erl"
  "*.hrl"
  "*.app"
  "*.app.src"
  "*.config"
  "*.script"
  "*.escript"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/efmt.nix

treefmt.programs.efmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/efmt.nix

treefmt.programs.elm-format.enable¶

Whether to enable elm-format.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/elm-format.nix

treefmt.programs.elm-format.package¶

The elm-format package to use.

Type: package

Default:

pkgs.elmPackages.elm-format

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/elm-format.nix

treefmt.programs.elm-format.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/elm-format.nix

treefmt.programs.elm-format.finalPackage¶

Resulting elm-format package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/elm-format.nix

treefmt.programs.elm-format.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.elm"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/elm-format.nix

treefmt.programs.elm-format.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/elm-format.nix

treefmt.programs.erlfmt.enable¶

Whether to enable erlfmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/erlfmt.nix

treefmt.programs.erlfmt.package¶

The erlfmt package to use.

Type: package

Default:

pkgs.erlfmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/erlfmt.nix

treefmt.programs.erlfmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/erlfmt.nix

treefmt.programs.erlfmt.finalPackage¶

Resulting erlfmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/erlfmt.nix

treefmt.programs.erlfmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.erl"
  "*.hrl"
  "*.app"
  "*.app.src"
  "*.config"
  "*.script"
  "*.escript"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/erlfmt.nix

treefmt.programs.erlfmt.print-width¶

The line length that formatter would wrap on

Type: signed integer

Default:

100

Example:

80

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/erlfmt.nix

treefmt.programs.erlfmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/erlfmt.nix

treefmt.programs.fantomas.enable¶

Whether to enable fantomas.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fantomas.nix

treefmt.programs.fantomas.package¶

The fantomas package to use.

Type: package

Default:

pkgs.fantomas

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fantomas.nix

treefmt.programs.fantomas.dotnet-sdk¶

The dotnet-sdk package to use.

Type: package

Default:

pkgs.dotnet-sdk

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fantomas.nix

treefmt.programs.fantomas.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fantomas.nix

treefmt.programs.fantomas.finalPackage¶

Resulting fantomas package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fantomas.nix

treefmt.programs.fantomas.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.fs"
  "*.fsx"
  "*.fsi"
  "*.ml"
  "*.mli"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fantomas.nix

treefmt.programs.fantomas.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fantomas.nix

treefmt.programs.fish_indent.enable¶

Whether to enable fish_indent.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fish_indent.nix

treefmt.programs.fish_indent.package¶

The fish package to use.

Type: package

Default:

pkgs.fish

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fish_indent.nix

treefmt.programs.fish_indent.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fish_indent.nix

treefmt.programs.fish_indent.finalPackage¶

Resulting fish_indent package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fish_indent.nix

treefmt.programs.fish_indent.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.fish"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fish_indent.nix

treefmt.programs.fish_indent.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fish_indent.nix

treefmt.programs.flake-edit.enable¶

Whether to enable flake-edit.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.flake-edit.package¶

The flake-edit package to use.

Type: package

Default:

pkgs.flake-edit

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.flake-edit.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.flake-edit.finalPackage¶

Resulting flake-edit package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.flake-edit.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "flake.nix"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.flake-edit.noLock¶

Skip updating the lockfile after editing flake.nix

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.flake-edit.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.flake-edit.settings.follow.aliases¶

Mapping of canonical input names to alternative names. Allows nested inputs like “nixpkgs-lib” to follow “nixpkgs”.

Type: attribute set of list of string

Default:

{ }

Example:

{
  nixpkgs = [
    "nixpkgs-lib"
  ];
}

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.flake-edit.settings.follow.ignore¶

List of inputs to ignore when following. Supports simple names (“systems”) or full paths (“crane.nixpkgs”).

Type: list of string

Default:

[ ]

Example:

[
  "systems"
  "crane.flake-utils"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/flake-edit.nix

treefmt.programs.fnlfmt.enable¶

Whether to enable fnlfmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fnlfmt.nix

treefmt.programs.fnlfmt.package¶

The fnlfmt package to use.

Type: package

Default:

pkgs.fnlfmt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fnlfmt.nix

treefmt.programs.fnlfmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fnlfmt.nix

treefmt.programs.fnlfmt.finalPackage¶

Resulting fnlfmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fnlfmt.nix

treefmt.programs.fnlfmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.fnl"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fnlfmt.nix

treefmt.programs.fnlfmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fnlfmt.nix

treefmt.programs.formatjson5.enable¶

Whether to enable formatjson5.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.package¶

The formatjson5 package to use.

Type: package

Default:

pkgs.formatjson5

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.finalPackage¶

Resulting formatjson5 package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.json5"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.indent¶

Indent by the given number of spaces

Type: signed integer

Default:

4

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.noTrailingCommas¶

Suppress trailing commas (otherwise added by default)

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.oneElementLines¶

Objects or arrays with a single child should collapse to a single line

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.formatjson5.sortArrays¶

Sort arrays of primitive values (string, number, boolean, or null) lexicographically

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/formatjson5.nix

treefmt.programs.fourmolu.enable¶

Whether to enable fourmolu.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fourmolu.nix

treefmt.programs.fourmolu.package¶

The fourmolu package to use.

Type: package

Default:

pkgs.haskellPackages.fourmolu

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fourmolu.nix

treefmt.programs.fourmolu.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fourmolu.nix

treefmt.programs.fourmolu.finalPackage¶

Resulting fourmolu package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fourmolu.nix

treefmt.programs.fourmolu.ghcOpts¶

Which GHC language extensions to enable

Type: unspecified value

Default:

[
  "BangPatterns"
  "PatternSynonyms"
  "TypeApplications"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fourmolu.nix

treefmt.programs.fourmolu.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.hs"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fourmolu.nix

treefmt.programs.fourmolu.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fourmolu.nix

treefmt.programs.fprettify.enable¶

Whether to enable fprettify.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fprettify.nix

treefmt.programs.fprettify.package¶

The fprettify package to use.

Type: package

Default:

pkgs.fprettify

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fprettify.nix

treefmt.programs.fprettify.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fprettify.nix

treefmt.programs.fprettify.finalPackage¶

Resulting fprettify package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fprettify.nix

treefmt.programs.fprettify.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.f90"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fprettify.nix

treefmt.programs.fprettify.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/fprettify.nix

treefmt.programs.gdformat.enable¶

Whether to enable gdformat.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gdformat.nix

treefmt.programs.gdformat.package¶

The gdtoolkit_4 package to use.

Type: package

Default:

pkgs.gdtoolkit_4

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gdformat.nix

treefmt.programs.gdformat.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gdformat.nix

treefmt.programs.gdformat.finalPackage¶

Resulting gdformat package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gdformat.nix

treefmt.programs.gdformat.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.gd"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gdformat.nix

treefmt.programs.gdformat.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gdformat.nix

treefmt.programs.genemichaels.enable¶

Whether to enable genemichaels, a Rust code formatter.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

treefmt.programs.genemichaels.package¶

The genemichaels package to use.

Type: package

Default:

pkgs.genemichaels

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

treefmt.programs.genemichaels.excludes¶

Path / file patterns to exclude for genemichaels.

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

treefmt.programs.genemichaels.includes¶

Path / file patterns to include for genemichaels.

Type: list of string

Default:

[
  "*.rs"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

treefmt.programs.genemichaels.settings.root_splits¶

When breaking a child element, also break all parent elements.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

treefmt.programs.genemichaels.settings.split_where¶

Put the where clause on a new line.

Type: boolean

Default:

true

Example:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

treefmt.programs.genemichaels.settingsFile¶

The configuration file used by genemichaels.

Type: absolute path

Default: Generated JSON file from treefmt.programs.genemichaels.settings

Example:

./.genemichaels.json

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

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: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/genemichaels.nix

treefmt.programs.gleam.enable¶

Whether to enable gleam.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gleam.nix

treefmt.programs.gleam.package¶

The gleam package to use.

Type: package

Default:

pkgs.gleam

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gleam.nix

treefmt.programs.gleam.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[ ]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gleam.nix

treefmt.programs.gleam.finalPackage¶

Resulting gleam package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gleam.nix

treefmt.programs.gleam.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.gleam"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gleam.nix

treefmt.programs.gleam.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gleam.nix

treefmt.programs.gofmt.enable¶

Whether to enable gofmt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofmt.nix

treefmt.programs.gofmt.package¶

The go package to use.

Type: package

Default:

pkgs.go

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofmt.nix

treefmt.programs.gofmt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[
  "vendor/*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofmt.nix

treefmt.programs.gofmt.finalPackage¶

Resulting gofmt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofmt.nix

treefmt.programs.gofmt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.go"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofmt.nix

treefmt.programs.gofmt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofmt.nix

treefmt.programs.gofumpt.enable¶

Whether to enable gofumpt.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofumpt.nix

treefmt.programs.gofumpt.package¶

The gofumpt package to use.

Type: package

Default:

pkgs.gofumpt

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofumpt.nix

treefmt.programs.gofumpt.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[
  "vendor/*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofumpt.nix

treefmt.programs.gofumpt.extra¶

Whether to enable extra rules.

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofumpt.nix

treefmt.programs.gofumpt.finalPackage¶

Resulting gofumpt package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofumpt.nix

treefmt.programs.gofumpt.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.go"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofumpt.nix

treefmt.programs.gofumpt.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/gofumpt.nix

treefmt.programs.goimports.enable¶

Whether to enable goimports.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/goimports.nix

treefmt.programs.goimports.package¶

The gotools package to use.

Type: package

Default:

pkgs.gotools

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/goimports.nix

treefmt.programs.goimports.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[
  "vendor/*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/goimports.nix

treefmt.programs.goimports.finalPackage¶

Resulting goimports package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/goimports.nix

treefmt.programs.goimports.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.go"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/goimports.nix

treefmt.programs.goimports.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/goimports.nix

treefmt.programs.golangci-lint.enable¶

Whether to enable golangci-lint.

Type: boolean

Default:

false

Example:

true

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.enableLinters¶

Enable specific linters

Type: list of string

Default:

[ ]

Example:

[
  "govet"
  "errcheck"
  "staticcheck"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.enableOnly¶

Override configuration to run only specific linter(s)

Type: list of string

Default:

[ ]

Example:

[
  "govet"
  "gofmt"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.package¶

The golangci-lint package to use.

Type: package

Default:

pkgs.golangci-lint

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.buildTags¶

Build tags to use during analysis

Type: list of string

Default:

[ ]

Example:

[
  "integration"
  "e2e"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.concurrency¶

Number of CPUs to use (auto-configured by default)

Type: null or signed integer

Default:

null

Example:

4

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.configFile¶

Path to golangci-lint configuration file

Type: null or string

Default:

null

Example:

".golangci.yml"

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.disableLinters¶

Disable specific linters

Type: list of string

Default:

[ ]

Example:

[
  "typecheck"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.excludes¶

Path / file patterns to exclude

Type: list of string

Default:

[
  "vendor/*"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.fastOnly¶

Run only fast linters from enabled linters set

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.finalPackage¶

Resulting golangci-lint package bundled with plugins, if any.

Type: package (read only)

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.includes¶

Path / file patterns to include

Type: list of string

Default:

[
  "*.go"
]

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.maxIssuesPerLinter¶

Maximum issues per linter (default: 50)

Type: null or signed integer

Default:

null

Example:

50

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.maxSameIssues¶

Maximum count of same issues (default: 3)

Type: null or signed integer

Default:

null

Example:

3

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.newFromRev¶

Show only new issues created after git revision REV

Type: null or string

Default:

null

Example:

"HEAD~1"

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.noConfig¶

Don’t read any configuration file

Type: boolean

Default:

false

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix

treefmt.programs.golangci-lint.priority¶

Priority

Type: null or signed integer

Default:

null

Declared by: - https://github.com/numtide/treefmt-nix/blob/71b125cd05fbfd78cab3e070b73544abe24c5016/programs/golangci-lint.nix