Skip to content

devenv.nix options

packages

A list of packages to expose inside the developer environment. Search available packages using devenv search NAME.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix

aws-vault.enable

Whether to enable aws-vault integration.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.package

The aws-vault package to use.

Type: package

Default: pkgs.aws-vault

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.awscliWrapper

Attribute set of packages including awscli2

Type: submodule

Default: pkgs

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.awscliWrapper.enable

Whether to enable Wraps awscli2 binary as aws-vault exec <profile> -- aws <args>. .

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.awscliWrapper.package

The awscli2 package to use.

Type: package

Default: pkgs.awscli2

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.opentofuWrapper

Attribute set of packages including opentofu

Type: submodule

Default: pkgs

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.opentofuWrapper.enable

Whether to enable Wraps opentofu binary as aws-vault exec <profile> -- opentofu <args>. .

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.opentofuWrapper.package

The opentofu package to use.

Type: package

Default: pkgs.opentofu

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.profile

The profile name passed to aws-vault exec.

Type: string

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.terraformWrapper

Attribute set of packages including terraform

Type: submodule

Default: pkgs

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.terraformWrapper.enable

Whether to enable Wraps terraform binary as aws-vault exec <profile> -- terraform <args>. .

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

aws-vault.terraformWrapper.package

The terraform package to use.

Type: package

Default: pkgs.terraform

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix

cachix.enable

Whether to enable Cachix integration.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix

cachix.pull

What caches to pull from.

Type: list of string

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix

cachix.push

What cache to push to. Automatically also adds it to the list of caches to pull from.

Type: null or string

Default: null

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix

certificates

List of domains to generate certificates for.

Type: list of string

Default: [ ]

Example:

[
  "example.com"
  "*.example.com"
]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix

container.isBuilding

Set to true when the environment is building a container.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers

Container specifications that can be built, copied and ran using devenv container.

Type: attribute set of (submodule)

Default: { }

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.copyToRoot

Add a path to the container. Defaults to the whole git repo.

Type: null or path or list of path

Default: "self"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.defaultCopyArgs

Default arguments to pass to skopeo copy. You can override them by passing arguments to the script.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.entrypoint

Entrypoint of the container.

Type: list of anything

Default: [ entrypoint ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.isBuilding

Set to true when the environment is building this container.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.maxLayers

Maximum number of container layers created.

Type: null or signed integer

Default: 1

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.name

Name of the container.

Type: null or string

Default: "top-level name or containers.mycontainer.name"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.registry

Registry to push the container to.

Type: null or string

Default: "docker-daemon:"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.startupCommand

Command to run in the container.

Type: null or string or package

Default: null

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

containers.<name>.version

Version/tag of the container.

Type: null or string

Default: "latest"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/containers.nix

delta.enable

Integrate delta into git: https://dandavison.github.io/delta/.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/delta.nix

devcontainer.enable

Whether to enable generation .devcontainer.json for devenv integration.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix

devcontainer.settings

Devcontainer settings.

Type: JSON value

Default: { }

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix

devcontainer.settings.customizations.vscode.extensions

List of preinstalled VSCode extensions.

Type: list of string

Default:

[
  "mkhl.direnv"
]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix

devcontainer.settings.image

The name of an image in a container registry.

Type: string

Default: "ghcr.io/cachix/devenv:latest"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix

devcontainer.settings.overrideCommand

Override the default command.

Type: anything

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix

devcontainer.settings.updateContentCommand

Command to run after container creation.

Type: anything

Default: "devenv test"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix

devenv.debug

Whether to enable debug mode of devenv enterShell script.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/debug.nix

devenv.flakesIntegration

Tells if devenv is being imported by a flake.nix file

Type: boolean

Default: true when devenv is invoked via the flake integration; false otherwise.

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix

devenv.latestVersion

The latest version of devenv.

Type: string

Default: "1.0.5"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix

devenv.warnOnNewVersion

Whether to warn when a new version of devenv is available.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix

difftastic.enable

Integrate difftastic into git: https://difftastic.wilfred.me.uk/.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/difftastic.nix

dotenv.enable

Whether to enable .env integration, doesn’t support comments or multiline values…

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix

dotenv.disableHint

Disable the hint that are printed when the dotenv module is not enabled, but .env is present.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix

dotenv.filename

The name of the dotenv file to load, or a list of dotenv files to load in order of precedence.

Type: string or list of string

Default: ".env"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix

enterShell

Bash code to execute when entering the shell.

Type: strings concatenated with “\n”

Default: ""

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix

enterTest

Bash code to execute to run the test.

Type: strings concatenated with “\n”

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/tests.nix

env

Environment variables to be exposed inside the developer environment.

Type: lazy attribute set of anything

Default: { }

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix

hosts

List of hosts entries.

Type: attribute set of (string or list of string)

Default: { }

Example:

{
  "another-example.com" = [
    "::1"
    "127.0.0.1"
  ];
  "example.com" = "127.0.0.1";
}

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix

hostsProfileName

Profile name to use.

Type: string

Default: "devenv-16a3de0b53062f3b6e6678a84f28e04344732e0002fcad6af20ffbeaa0491014"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix

infoSections

Information about the environment

Type: attribute set of list of string

Default: { }

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/info.nix

languages.ansible.enable

Whether to enable tools for Ansible development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix

languages.ansible.package

The Ansible package to use.

Type: package

Default: pkgs.ansible

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix

languages.c.enable

Whether to enable tools for C development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix

languages.clojure.enable

Whether to enable tools for Clojure development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix

languages.cplusplus.enable

Whether to enable tools for C++ development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix

languages.crystal.enable

Whether to enable Enable tools for Crystal development…

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix

languages.cue.enable

Whether to enable tools for Cue development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix

languages.cue.package

The CUE package to use.

Type: package

Default: pkgs.cue

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix

languages.dart.enable

Whether to enable tools for Dart development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix

languages.dart.package

The Dart package to use.

Type: package

Default: pkgs.dart

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix

languages.deno.enable

Whether to enable tools for Deno development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix

languages.dotnet.enable

Whether to enable tools for .NET development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix

languages.dotnet.package

The .NET SDK package to use.

Type: package

Default: pkgs.dotnet-sdk

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix

languages.elixir.enable

Whether to enable tools for Elixir development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix

languages.elixir.package

Which package of Elixir to use.

Type: package

Default: pkgs.elixir

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix

languages.elm.enable

Whether to enable tools for Elm development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix

languages.erlang.enable

Whether to enable tools for Erlang development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix

languages.erlang.package

Which package of Erlang to use.

Type: package

Default: pkgs.erlang

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix

languages.fortran.enable

Whether to enable tools for Fortran Development…

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix

languages.fortran.package

The Fortran package to use.

Type: package

Default: pkgs.gfortran

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix

languages.gawk.enable

Whether to enable tools for GNU Awk development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/gawk.nix

languages.gleam.enable

Whether to enable tools for Gleam development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix

languages.gleam.package

The Gleam package to use.

Type: package

Default: pkgs.gleam

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix

languages.go.enable

Whether to enable tools for Go development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix

languages.go.package

The Go package to use.

Type: package

Default: pkgs.go

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix

languages.haskell.enable

Whether to enable tools for Haskell development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix

languages.haskell.package

Haskell compiler to use.

Type: package

Default: "pkgs.ghc"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix

languages.haskell.languageServer

Haskell language server to use.

Type: null or package

Default: "pkgs.haskell-language-server"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix

languages.haskell.stack

Haskell stack to use.

Type: null or package

Default: "pkgs.stack"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix

languages.idris.enable

Whether to enable tools for Idris development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix

languages.idris.package

The Idris package to use.

Type: package

Default: "pkgs.idris2"

Example: "pkgs.idris"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix

languages.java.enable

Whether to enable tools for Java development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix

languages.java.gradle.enable

Whether to enable gradle.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix

languages.java.gradle.package

The Gradle package to use. The Gradle package by default inherits the JDK from languages.java.jdk.package.

Type: package

Default: pkgs.gradle.override { java = cfg.jdk.package; }

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix

languages.java.jdk.package

The JDK package to use. This will also become available as JAVA_HOME.

Type: package

Default: pkgs.jdk

Example: pkgs.jdk8

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix

languages.java.maven.enable

Whether to enable maven.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix

languages.java.maven.package

The Maven package to use. The Maven package by default inherits the JDK from languages.java.jdk.package.

Type: package

Default: "pkgs.maven.override { jdk = cfg.jdk.package; }"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix

languages.javascript.enable

Whether to enable tools for JavaScript development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.package

The Node.js package to use.

Type: package

Default: pkgs.nodejs-slim

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.bun.enable

Whether to enable install bun.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.bun.package

The bun package to use.

Type: package

Default: pkgs.bun

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.bun.install.enable

Whether to enable bun install during devenv initialisation.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.corepack.enable

Whether to enable wrappers for npm, pnpm and Yarn via Node.js Corepack.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.directory

The JavaScript project’s root directory. Defaults to the root of the devenv project. Can be an absolute path or one relative to the root of the devenv project.

Type: string

Default: config.devenv.root

Example: "./directory"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.npm.enable

Whether to enable install npm.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.npm.package

The Node.js package to use.

Type: package

Default: pkgs.nodejs

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.npm.install.enable

Whether to enable npm install during devenv initialisation.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.pnpm.enable

Whether to enable install pnpm.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.pnpm.package

The pnpm package to use.

Type: package

Default: pkgs.nodePackages.pnpm

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.pnpm.install.enable

Whether to enable pnpm install during devenv initialisation.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.yarn.enable

Whether to enable install yarn.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.yarn.package

The yarn package to use.

Type: package

Default: pkgs.yarn

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.javascript.yarn.install.enable

Whether to enable yarn install during devenv initialisation.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix

languages.jsonnet.enable

Whether to enable tools for jsonnet development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix

languages.julia.enable

Whether to enable tools for Julia development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix

languages.julia.package

The Julia package to use.

Type: package

Default: pkgs.julia-bin

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix

languages.kotlin.enable

Whether to enable tools for Kotlin development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix

languages.lua.enable

Whether to enable tools for Lua development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix

languages.lua.package

The Lua package to use.

Type: package

Default: pkgs.lua

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix

languages.nim.enable

Whether to enable tools for Nim development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix

languages.nim.package

The Nim package to use.

Type: package

Default: pkgs.nim

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix

languages.nix.enable

Whether to enable tools for Nix development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix

languages.nix.lsp.package

The LSP package to use

Type: package

Default: pkgs.nil

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix

languages.ocaml.enable

Whether to enable tools for OCaml development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix

languages.ocaml.packages

The package set of OCaml to use

Type: attribute set

Default: pkgs.ocaml-ng.ocamlPackages_4_12

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix

languages.odin.enable

Whether to enable tools for Odin Language.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix

languages.odin.package

The odin package to use.

Type: package

Default: pkgs.odin

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix

languages.odin.debugger

The debugger package to use with odin.

Type: package

Default: pkgs.gdb

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix

languages.opentofu.enable

Whether to enable tools for OpenTofu development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix

languages.opentofu.package

The OpenTofu package to use.

Type: package

Default: pkgs.opentofu

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix

languages.pascal.enable

Whether to enable tools for Pascal development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix

languages.pascal.lazarus.enable

Whether to enable lazarus graphical IDE for the FreePascal language.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix

languages.perl.enable

Whether to enable tools for Perl development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix

languages.perl.packages

Perl packages to include

Type: list of string

Default: [ ]

Example:

[
  "Mojolicious"
]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix

languages.php.enable

Whether to enable tools for PHP development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.package

Allows you to override the default used package to adjust the settings or add more extensions. You can find the extensions using devenv search 'php extensions'

Type: package

Default: pkgs.php

Example:

pkgs.php.buildEnv {
  extensions = { all, enabled }: with all; enabled ++ [ xdebug ];
  extraConfig = ''
    memory_limit=1G
  '';
};

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.packages

Attribute set of packages including composer

Type: submodule

Default: pkgs

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.packages.composer

composer package

Type: null or package

Default: pkgs.phpPackages.composer

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.disableExtensions

PHP extensions to disable.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.extensions

PHP extensions to enable.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.extraConfig

Extra configuration that should be put in the global section of the PHP-FPM configuration file. Do not specify the options error_log or daemonize here, since they are generated by NixOS.

Type: null or strings concatenated with “\n”

Default: null

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.phpOptions

Options appended to the PHP configuration file php.ini.

Type: strings concatenated with “\n”

Default: ""

Example:

''
  date.timezone = "CET"
''

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.pools

PHP-FPM pools. If no pools are defined, the PHP-FPM service is disabled.

Type: attribute set of (submodule)

Default: { }

Example:

{
  mypool = {
    user = "php";
    group = "php";
    phpPackage = pkgs.php;
    settings = {
      "pm" = "dynamic";
      "pm.max_children" = 75;
      "pm.start_servers" = 10;
      "pm.min_spare_servers" = 5;
      "pm.max_spare_servers" = 20;
      "pm.max_requests" = 500;
    };
  }
}

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.pools.<name>.extraConfig

Extra lines that go into the pool configuration. See the documentation on php-fpm.conf for details on configuration directives.

Type: null or strings concatenated with “\n”

Default: null

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.pools.<name>.listen

The address on which to accept FastCGI requests.

Type: string

Default: ""

Example: "/path/to/unix/socket"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.pools.<name>.phpEnv

Environment variables used for this PHP-FPM pool.

Type: attribute set of string

Default: { }

Example:

{
  HOSTNAME = "$HOSTNAME";
  TMP = "/tmp";
  TMPDIR = "/tmp";
  TEMP = "/tmp";
}

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.pools.<name>.phpOptions

Options appended to the PHP configuration file php.ini used for this PHP-FPM pool.

Type: strings concatenated with “\n”

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.pools.<name>.phpPackage

The PHP package to use for running this PHP-FPM pool.

Type: package

Default: phpfpm.phpPackage

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.pools.<name>.settings

PHP-FPM pool directives. Refer to the “List of pool directives” section of https://www.php.net/manual/en/install.fpm.configuration.php" the manual for details. Note that settings names must be enclosed in quotes (e.g. "pm.max_children" instead of pm.max_children).

Type: attribute set of (string or signed integer or boolean)

Default: { }

Example:

{
  "pm" = "dynamic";
  "pm.max_children" = 75;
  "pm.start_servers" = 10;
  "pm.min_spare_servers" = 5;
  "pm.max_spare_servers" = 20;
  "pm.max_requests" = 500;
}

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.pools.<name>.socket

Path to the Unix socket file on which to accept FastCGI requests.

This option is read-only and managed by NixOS.

Type: string (read only)

Example: "/home/runner/work/devenv/devenv/.devenv/state/php-fpm/<name>.sock"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.fpm.settings

PHP-FPM global directives.

Refer to the “List of global php-fpm.conf directives” section of https://www.php.net/manual/en/install.fpm.configuration.php for details.

Note that settings names must be enclosed in quotes (e.g. "pm.max_children" instead of pm.max_children).

You need not specify the options error_log or daemonize here, since they are already set.

Type: attribute set of (string or signed integer or boolean)

Default:

{
  error_log = "/home/runner/work/devenv/devenv/.devenv/state/php-fpm/php-fpm.log";
}

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.ini

PHP.ini directives. Refer to the “List of php.ini directives” of PHP’s

Type: null or strings concatenated with “\n”

Default: ""

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.php.version

The PHP version to use.

Type: string

Default: ""

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix

languages.purescript.enable

Whether to enable tools for PureScript development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix

languages.purescript.package

The PureScript package to use.

Type: package

Default: pkgs.purescript

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix

languages.python.enable

Whether to enable tools for Python development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.package

The Python package to use.

Type: package

Default: pkgs.python3

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.directory

The Python project’s root directory. Defaults to the root of the devenv project. Can be an absolute path or one relative to the root of the devenv project.

Type: string

Default: config.devenv.root

Example: "./directory"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.libraries

Additional libraries to make available to the Python interpreter.

This is useful when you want to use Python wheels that depend on native libraries.

Type: list of path

Default:

[
  "/home/runner/work/devenv/devenv/.devenv/profile"
]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.manylinux.enable

Whether to install manylinux2014 libraries.

Enabled by default on linux;

This is useful when you want to use Python wheels that depend on manylinux2014 libraries.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.enable

Whether to enable poetry.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.package

The Poetry package to use.

Type: package

Default: pkgs.poetry

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.activate.enable

Whether to activate the poetry virtual environment automatically.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.enable

Whether to enable poetry install during devenv initialisation.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.allExtras

Whether to install all extras. See --all-extras.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.compile

Whether poetry install should compile Python source files to bytecode.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.extras

Which extras to install. See --extras.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.groups

Which dependency groups to install. See --with.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.ignoredGroups

Which dependency groups to ignore. See --without.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.installRootPackage

Whether the root package (your project) should be installed. See --no-root

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.onlyGroups

Which dependency groups to exclusively install. See --only.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.onlyInstallRootPackage

Whether to only install the root package (your project) should be installed, but no dependencies. See --only-root

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.quiet

Whether poetry install should avoid outputting messages during devenv initialisation.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.poetry.install.verbosity

What level of verbosity the output of poetry install should have.

Type: one of “no”, “little”, “more”, “debug”

Default: "no"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.uv.enable

Whether to enable uv.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.uv.package

The uv package to use.

Type: package

Default: pkgs.uv

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.venv.enable

Whether to enable Python virtual environment.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.venv.quiet

Whether pip install should avoid outputting messages during devenv initialisation.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.venv.requirements

Contents of pip requirements.txt file. This is passed to pip install -r during devenv shell initialisation.

Type: null or strings concatenated with “\n” or path

Default: null

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.python.version

The Python version to use. This automatically sets the languages.python.package using nixpkgs-python.

Type: null or string

Default: null

Example: "3.11 or 3.11.2"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix

languages.r.enable

Whether to enable tools for R development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix

languages.r.package

The R package to use.

Type: package

Default: pkgs.R

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix

languages.racket.enable

Whether to enable tools for Racket development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix

languages.racket.package

The Racket package to use.

Type: package

Default: pkgs.racket-minimal

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix

languages.raku.enable

Whether to enable tools for Raku development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/raku.nix

languages.robotframework.enable

Whether to enable tools for Robot Framework development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix

languages.robotframework.python

The Python package to use.

Type: package

Default: pkgs.python3

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix

languages.ruby.enable

Whether to enable tools for Ruby development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix

languages.ruby.package

The Ruby package to use.

Type: package

Default: pkgs.ruby_3_1

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix

languages.ruby.bundler.enable

Whether to enable bundler.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix

languages.ruby.bundler.package

The bundler package to use.

Type: package

Default: pkgs.bundler.override { ruby = cfg.package; }

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix

languages.ruby.version

The Ruby version to use. This automatically sets the languages.ruby.package using nixpkgs-ruby.

Type: null or string

Default: null

Example: "3.2.1"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix

languages.ruby.versionFile

The .ruby-version file path to extract the Ruby version from. This automatically sets the languages.ruby.package using nixpkgs-ruby. When the .ruby-version file exists in the same directory as the devenv configuration, you can use:

languages.ruby.versionFile = ./.ruby-version;

Type: null or path

Default: null

Example:

./ruby-version

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix

languages.rust.enable

Whether to enable tools for Rust development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.channel

The rustup toolchain to install.

Type: one of “nixpkgs”, “stable”, “beta”, “nightly”

Default: "nixpkgs"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.components

List of Rustup components to install. Defaults to those available in nixpkgs.

Type: list of string

Default: [ "rustc" "cargo" "clippy" "rustfmt" "rust-analyzer" ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.mold.enable

Enable mold as the linker.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.rustflags

Extra flags to pass to the Rust compiler.

Type: string

Default: ""

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.targets

List of extra targets to install. Defaults to only the native target.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.toolchain

Rust component packages. May optionally define additional components, for example miri.

Type: attribute set of package

Default: nixpkgs

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.toolchain.cargo

cargo package

Type: null or package

Default: pkgs.cargo

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.toolchain.clippy

clippy package

Type: null or package

Default: pkgs.clippy

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.toolchain.rust-analyzer

rust-analyzer package

Type: null or package

Default: pkgs.rust-analyzer

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.toolchain.rustc

rustc package

Type: null or package

Default: pkgs.rustc

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.rust.toolchain.rustfmt

rustfmt package

Type: null or package

Default: pkgs.rustfmt

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix

languages.scala.enable

Whether to enable tools for Scala development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix

languages.scala.package

The Scala package to use.

Type: package

Default: "pkgs.scala_3"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix

languages.shell.enable

Whether to enable tools for shell development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix

languages.standardml.enable

Whether to enable tools for Standard ML development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix

languages.standardml.package

The Standard ML package to use.

Type: package

Default: "pkgs.mlton"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix

languages.swift.enable

Whether to enable tools for Swift development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix

languages.swift.package

The Swift package to use.

Type: package

Default: "pkgs.swift"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix

languages.terraform.enable

Whether to enable tools for Terraform development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix

languages.terraform.package

The Terraform package to use.

Type: package

Default: pkgs.terraform

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix

languages.terraform.version

The Terraform version to use. This automatically sets the languages.terraform.package using nixpkgs-terraform.

Type: null or string

Default: null

Example: "1.5.0 or 1.6.2"

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix

languages.texlive.enable

Whether to enable TeX Live.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix

languages.texlive.packages

Packages available to TeX Live

Type: non-empty (list of string)

Default:

[
  "collection-basic"
]

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix

languages.texlive.base

TeX Live package set to use

Type: unspecified value

Default: pkgs.texlive

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix

languages.typescript.enable

Whether to enable tools for TypeScript development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix

languages.unison.enable

Whether to enable tools for Unison development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix

languages.unison.package

Which package of Unison to use

Type: package

Default: pkgs.unison-ucm

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix

languages.v.enable

Whether to enable tools for V development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix

languages.v.package

The V package to use.

Type: package

Default: pkgs.vlang

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix

languages.vala.enable

Whether to enable tools for Vala development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix

languages.vala.package

The Vala package to use.

Type: package

Default: pkgs.vala

Example: pkgs.vala_0_54

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix

languages.zig.enable

Whether to enable tools for Zig development.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix

languages.zig.package

Which package of Zig to use.

Type: package

Default: pkgs.zig

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix

name

Name of the project.

Type: null or string

Default: null

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix

pre-commit

Integration of https://github.com/cachix/pre-commit-hooks.nix

Type: submodule

Default: { }

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/integrations/pre-commit.nix

pre-commit.enabledPackages

All packages provided by hooks that are enabled.

Useful for including into the developer environment.

Type: list of unspecified value

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix

pre-commit.package

The pre-commit package to use.

Type: package

Default:

pkgs.pre-commit

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix

pre-commit.default_stages

A configuration wide option for the stages property. Installs hooks to the defined stages. See https://pre-commit.com/#confining-hooks-to-run-at-certain-stages.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default:

[
  "pre-commit"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix

pre-commit.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix

pre-commit.hooks

The hook definitions.

You can both specify your own hooks here and you can enable predefined hooks.

Example of enabling a predefined hook:

hooks.nixpkgs-fmt.enable = true;

Example of a custom hook:

hooks.my-tool = {
  enable = true;
  name = "my-tool";
  description = "Run MyTool on all files in the project";
  files = "\.mtl$";
  entry = "${pkgs.my-tool}/bin/mytoolctl";
};

The predefined hooks are:

actionlint

Static checker for GitHub Actions workflow files

alejandra

The Uncompromising Nix Code Formatter

annex

Runs the git-annex hook for large file support

ansible-lint

Ansible linter

autoflake

Remove unused imports and variables from Python code

bats

Run bash unit tests

beautysh

Format shell files

black

The uncompromising Python code formatter

cabal-fmt

Format Cabal files

cabal2nix

Run cabal2nix on all *.cabal files to generate corresponding default.nix files

cargo-check

Check the cargo package for errors

check-added-large-files

Prevent very large files to be committed (e.g. binaries).

check-builtin-literals

Require literal syntax when initializing empty or zero builtin types in Python.

check-case-conflicts

Check for files that would conflict in case-insensitive filesystems.

check-docstring-first

Check that all docstrings appear above the code.

check-executables-have-shebangs

Ensure that all non-binary executables have shebangs.

check-json

Check syntax of JSON files.

check-merge-conflicts

Check for files that contain merge conflict strings.

check-python

Check syntax of Python file by parsing Python abstract syntax tree.

check-shebang-scripts-are-executable

Ensure that all (non-binary) files with a shebang are executable.

check-symlinks

Find broken symlinks.

check-toml

Check syntax of TOML files.

check-vcs-permalinks

Ensure that links to VCS websites are permalinks.

check-xml

Check syntax of TOML files.

check-yaml

Check syntax of YAML files.

checkmake

Experimental linter/analyzer for Makefiles

chktex

LaTeX semantic checker

clang-format

Format your code using clang-format.

clang-tidy

Static analyzer for C++ code.

clippy

Lint Rust code.

cljfmt

A tool for formatting Clojure code.

cmake-format

A tool for formatting CMake-files.

commitizen

Check whether the current commit message follows committing rules.

conform

Policy enforcement for commits.

convco

credo

Runs a static code analysis using Credo

crystal

A tool that automatically formats Crystal source code

cspell

A Spell Checker for Code

deadnix

Scan Nix files for dead code (unused variable bindings).

denofmt

Auto-format JavaScript, TypeScript, Markdown, and JSON files.

denolint

Lint JavaScript/TypeScript source code.

detect-aws-credentials

Detect AWS credentials from the AWS cli credentials file.

detect-private-keys

Detect the presence of private keys.

dhall-format

Dhall code formatter.

dialyzer

Runs a static code analysis using Dialyzer

dune-fmt

Runs Dune’s formatters on the code tree.

dune-opam-sync

Check that Dune-generated OPAM files are in sync.

eclint

EditorConfig linter written in Go.

editorconfig-checker

Verify that the files are in harmony with the .editorconfig.

elm-format

Format Elm files.

elm-review

Analyzes Elm projects, to help find mistakes before your users find them.

elm-test

Run unit tests and fuzz tests for Elm code.

end-of-file-fixer

Ensures that a file is either empty, or ends with a single newline.

eslint

Find and fix problems in your JavaScript code.

fix-byte-order-marker

Remove UTF-8 byte order marker.

fix-encoding-pragma

Adds # -- coding: utf-8 -- to the top of Python files.’

flake-checker

Run health checks on your flake-powered Nix projects.

flake8

Check the style and quality of Python files.

flynt

CLI tool to convert a python project’s %-formatted strings to f-strings.

forbid-new-submodules

Prevent addition of new Git submodules.

fourmolu

Haskell code prettifier.

fprettify

Auto-formatter for modern Fortran code.

gofmt

A tool that automatically formats Go source code

golangci-lint

Fast linters runner for Go.

gotest

Run go tests

govet

Checks correctness of Go programs.

gptcommit

Generate a commit message using GPT3.

hadolint

Dockerfile linter, validate inline bash.

headache

Lightweight tool for managing headers in source code files.

hindent

Haskell code prettifier.

hlint

HLint gives suggestions on how to improve your source code.

hpack

hpack converts package definitions in the hpack format (package.yaml) to Cabal files.

html-tidy

HTML linter.

hunspell

Spell checker and morphological analyzer.

isort

A Python utility / library to sort imports.

juliaformatter

Run JuliaFormatter.jl against Julia source files

lacheck

A consistency checker for LaTeX documents.

latexindent

Perl script to add indentation to LaTeX files.

lua-ls

Uses the lua-language-server CLI to statically type-check and lint Lua code.

luacheck

A tool for linting and static analysis of Lua code.

lychee

A fast, async, stream-based link checker that finds broken hyperlinks and mail addresses inside Markdown, HTML, reStructuredText, or any other text file or website.

markdownlint

Style checker and linter for markdown files.

mdl

A tool to check markdown files and flag style issues.

mdsh

Markdown shell pre-processor.

mix-format

Runs the built-in Elixir syntax formatter

mix-test

Runs the built-in Elixir test framework

mixed-line-endings

Resolve mixed line endings.

mkdocs-linkcheck

Validate links associated with markdown-based, statically generated websites.

mypy

Static type checker for Python

name-tests-test

Verify that Python test files are named correctly.

nil

Incremental analysis assistant for writing in Nix.

nixfmt

Nix code prettifier.

nixpkgs-fmt

Nix code prettifier.

no-commit-to-branch

Disallow committing to certain branch/branches.

ocp-indent

A tool to indent OCaml code.

opam-lint

OCaml package manager configuration checker.

ormolu

Haskell code prettifier.

php-cs-fixer

Lint PHP files.

phpcbf

Lint PHP files.

phpcs

Lint PHP files.

phpstan

Static Analysis of PHP files.

poetry-check

Check the Poetry config for errors

poetry-lock

Update the Poetry lock file

pre-commit-hook-ensure-sops

prettier

Opinionated multi-language code formatter.

pretty-format-json

Formats JSON files.

psalm

Static Analysis of PHP files.

purs-tidy

Format purescript files.

purty

Format purescript files.

pylint

Lint Python files.

pyright

Static type checker for Python

python-debug-statements

Check for debugger imports and py37+ breakpoint() calls in python source.

pyupgrade

Automatically upgrade syntax for newer versions.

revive

A linter for Go source code.

ripsecrets

Prevent committing secret keys into your source code

rome

Unified developer tools for JavaScript, TypeScript, and the web

ruff

An extremely fast Python linter, written in Rust.

rustfmt

Format Rust code.

shellcheck

Format shell files.

shfmt

Format shell files.

single-quoted-strings

Replace double quoted strings with single quoted strings.

sort-file-contents

Sort the lines in specified files (defaults to alphabetical).

sort-requirements-txt

Sort requirements in requirements.txt and constraints.txt files.

sort-simple-yaml

Sort simple YAML files which consist only of top-level keys, preserving comments and blocks.

staticcheck

State of the art linter for the Go programming language

statix

Lints and suggestions for the Nix programming language.

stylish-haskell

A simple Haskell code prettifier

stylua

An Opinionated Lua Code Formatter.

tagref

Have tagref check all references and tags.

taplo

Format TOML files with taplo fmt

terraform-format

Format terraform (.tf) files.

tflint

A Pluggable Terraform Linter.

topiary

A universal formatter engine within the Tree-sitter ecosystem, with support for many languages.

treefmt

One CLI to format the code tree.

trim-trailing-whitespace

Trim trailing whitespace.

typos

Source code spell checker

typstfmt

format typst

vale

A markup-aware linter for prose built with speed and extensibility in mind.

yamllint

Linter for YAML files.

zprint

Beautifully format Clojure and Clojurescript source code and s-expressions.

Type: attribute set of (submodule)

Default: { }

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix

pre-commit.hooks.<name>.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.<name>.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra

alejandra hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.alejandra.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.settings.check

Check if the input is already formatted and disable writing in-place the modified content

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.alejandra.settings.exclude

Files or directories to exclude from formatting.

Type: list of string

Default: [ ]

Example:

[
  "flake.nix"
  "./templates"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.alejandra.settings.threads

Number of formatting threads to spawn.

Type: null or signed integer

Default: null

Example: 8

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.alejandra.settings.verbosity

Whether informational messages or all messages should be hidden or not.

Type: one of “normal”, “quiet”, “silent”

Default: "normal"

Example: "quiet"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.alejandra.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.alejandra.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint

ansible-lint hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.ansible-lint.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.settings.configPath

Path to the YAML configuration file.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.ansible-lint.settings.subdir

Path to the Ansible subdirectory.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.ansible-lint.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ansible-lint.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake

autoflake hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.autoflake.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.settings.binPath

Path to autoflake binary.

Type: null or string

Default:

"${tools.autoflake}/bin/autoflake"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.autoflake.settings.flags

Flags passed to autoflake.

Type: string

Default: "--in-place --expand-star-imports --remove-duplicate-keys --remove-unused-variables"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.autoflake.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.autoflake.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black

black hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.black.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.settings.flags

Flags passed to black. See all available here.

Type: string

Default: ""

Example: "--skip-magic-trailing-comma"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.black.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.black.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy

clippy hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.clippy.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.packageOverrides.cargo

The cargo package to use

Type: package

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.clippy.packageOverrides.clippy

The clippy package to use

Type: package

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.clippy.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.settings.allFeatures

Run clippy with --all-features

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.clippy.settings.denyWarnings

Fail when warnings are present

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.clippy.settings.offline

Run clippy offline

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.clippy.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.clippy.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format

cmake-format hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.cmake-format.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.settings.configPath

Path to the configuration file (.json,.python,.yaml)

Type: string

Default: ""

Example: ".cmake-format.json"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.cmake-format.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.cmake-format.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo

credo hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.credo.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.settings.strict

Whether to auto-promote the changes.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.credo.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.credo.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix

deadnix hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.deadnix.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.settings.edit

Remove unused code and write to source file.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.deadnix.settings.exclude

Files to exclude from analysis.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.deadnix.settings.hidden

Recurse into hidden subdirectories and process hidden .*.nix files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.deadnix.settings.noLambdaArg

Don’t check lambda parameter arguments.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.deadnix.settings.noLambdaPatternNames

Don’t check lambda pattern names (don’t break nixpkgs callPackage).

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.deadnix.settings.noUnderscore

Don’t check any bindings that start with a _.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.deadnix.settings.quiet

Don’t print a dead code report.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.deadnix.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.deadnix.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt

denofmt hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.denofmt.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.settings.configPath

Path to the configuration JSON file

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.denofmt.settings.write

Whether to edit files inplace.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.denofmt.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denofmt.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint

denolint hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.denolint.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.settings.configPath

Path to the configuration JSON file

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.denolint.settings.format

Output format.

Type: one of “default”, “compact”, “json”

Default: "default"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.denolint.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.denolint.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt

dune-fmt hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.dune-fmt.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.settings.auto-promote

Whether to auto-promote the changes.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.dune-fmt.settings.extraRuntimeInputs

Extra runtimeInputs to add to the environment, eg. ocamlformat.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.dune-fmt.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.dune-fmt.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint

eclint hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eclint.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.settings.color

When to generate colored output.

Type: one of “auto”, “always”, “never”

Default: "auto"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eclint.settings.exclude

Filter to exclude files.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eclint.settings.fix

Modify files in place rather than showing the errors.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eclint.settings.summary

Only show number of errors per file.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eclint.settings.verbosity

Log level verbosity

Type: one of 0, 1, 2, 3, 4

Default: 0

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eclint.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eclint.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint

eslint hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eslint.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.settings.binPath

eslint binary path. E.g. if you want to use the eslint in node_modules, use ./node_modules/.bin/eslint.

Type: null or path

Default: ${tools.eslint}/bin/eslint

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eslint.settings.extensions

The pattern of files to run on, see https://pre-commit.com/#hooks-files.

Type: string

Default: "\.js$"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.eslint.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.eslint.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8

flake8 hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flake8.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.settings.binPath

flake8 binary path. Should be used to specify flake8 binary from your Nix-managed Python environment.

Type: null or string

Default:

"${tools.flake8}/bin/flake8"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flake8.settings.extendIgnore

List of additional ignore codes

Type: list of string

Default: [ ]

Example:

[
  "E501"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flake8.settings.format

Output format.

Type: string

Default: "default"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flake8.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flake8.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt

flynt hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.settings.aggressive

Include conversions with potentially changed behavior.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.binPath

flynt binary path. Can be used to specify the flynt binary from an existing Python environment.

Type: null or string

Default: "\${hooks.flynt.package}/bin/flynt"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.dry-run

Do not change files in-place and print diff instead.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.exclude

Ignore files with given strings in their absolute path.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.fail-on-change

Fail when diff is not empty (for linting purposes).

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.line-length

Convert expressions spanning multiple lines, only if the resulting single line will fit into this line length limit.

Type: null or signed integer

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.no-multiline

Convert only single line expressions.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.quiet

Run without output.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.string

Interpret the input as a Python code snippet and print the converted version.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.transform-concats

Replace string concatenations with f-strings.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.settings.verbose

Run with verbose output.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.flynt.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.flynt.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache

headache hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.headache.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.settings.header-file

Path to the header file.

Type: string

Default: ".header"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.headache.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.headache.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint

hlint hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.hlint.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.settings.hintFile

Path to hlint.yaml. By default, hlint searches for .hlint.yaml in the project root.

Type: null or path

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.hlint.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hlint.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack

hpack hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.hpack.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.settings.silent

Whether generation should be silent.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.hpack.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.hpack.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort

isort hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.isort.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.settings.flags

Flags passed to isort. See all available here.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.isort.settings.profile

Built-in profiles to allow easy interoperability with common projects and code styles.

Type: one of “”, “black”, “django”, “pycharm”, “google”, “open_stack”, “plone”, “attrs”, “hug”, “wemake”, “appnexus”

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.isort.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.isort.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck

lacheck hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.lacheck.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lacheck.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent

latexindent hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.latexindent.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.settings.flags

Flags passed to latexindent. See available flags here

Type: string

Default: "--local --silent --overwriteIfDifferent"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.latexindent.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.latexindent.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls

lua-ls hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.lua-ls.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.settings.checklevel

The diagnostic check level

Type: one of “Error”, “Warning”, “Information”, “Hint”

Default: "Warning"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.lua-ls.settings.configuration

See https://github.com/LuaLS/lua-language-server/wiki/Configuration-File#luarcjson

Type: attribute set

Default: { }

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.lua-ls.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lua-ls.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee

lychee hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.lychee.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.settings.configPath

Path to the config file.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.lychee.settings.flags

Flags passed to lychee. See all available here.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.lychee.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.lychee.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint

markdownlint hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.markdownlint.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.settings.configuration

See https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc

Type: attribute set

Default: { }

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.markdownlint.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.markdownlint.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl

mdl hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.settings.configPath

The configuration file to use.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.git-recurse

Only process files known to git when given a directory.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.ignore-front-matter

Ignore YAML front matter.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.json

Format output as JSON.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.rules

Markdown rules to use for linting. Per default all rules are processed.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.rulesets

Specify additional ruleset files to load.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.show-aliases

Show rule alias instead of rule ID when viewing rules.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.skip-default-ruleset

Do not load the default markdownlint ruleset. Use this option if you only want to load custom rulesets.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.style

Select which style mdl uses.

Type: string

Default: "default"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.tags

Markdown rules to use for linting containing the given tags. Per default all rules are processed.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.verbose

Increase verbosity.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.settings.warnings

Show Kramdown warnings.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mdl.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mdl.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck

mkdocs-linkcheck hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mkdocs-linkcheck.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.settings.binPath

mkdocs-linkcheck binary path. Should be used to specify the mkdocs-linkcheck binary from your Nix-managed Python environment.

Type: null or path

Default:

"${tools.mkdocs-linkcheck}/bin/mkdocs-linkcheck"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mkdocs-linkcheck.settings.extension

File extension to scan for.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mkdocs-linkcheck.settings.local-only

Whether to only check local links.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mkdocs-linkcheck.settings.method

HTTP method to use when checking external links.

Type: one of “get”, “head”

Default: "get"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mkdocs-linkcheck.settings.path

Path to check

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mkdocs-linkcheck.settings.recurse

Whether to recurse directories under path.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mkdocs-linkcheck.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mkdocs-linkcheck.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy

mypy hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mypy.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.settings.binPath

Mypy binary path. Should be used to specify the mypy executable in an environment containing your typing stubs.

Type: null or string

Default:

"${tools.mypy}/bin/mypy"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.mypy.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.mypy.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt

nixfmt hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.nixfmt.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.settings.width

Line width.

Type: null or signed integer

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.nixfmt.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.nixfmt.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch

no-commit-to-branch-hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.no-commit-to-branch.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.settings.branch

Branches to disallow commits to.

Type: list of string

Default:

[
  "main"
]

Example:

[
  "main"
  "master"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.no-commit-to-branch.settings.pattern

RegEx patterns for branch names to disallow commits to.

Type: list of string

Default: [ ]

Example:

[
  "ma.*"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.no-commit-to-branch.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.no-commit-to-branch.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu

ormolu hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.ormolu.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.settings.cabalDefaultExtensions

Use default-extensions from .cabal files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.ormolu.settings.defaultExtensions

Haskell language extensions to enable.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.ormolu.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.ormolu.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer

php-cs-fixer hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.php-cs-fixer.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.settings.binPath

PHP-CS-Fixer binary path.

Type: null or string

Default:

"${tools.php-cs-fixer}/bin/php-cs-fixer"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.php-cs-fixer.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.php-cs-fixer.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf

phpcbf hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.phpcbf.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.settings.binPath

PHP_CodeSniffer binary path.

Type: null or string

Default:

"${tools.phpcbf}/bin/phpcbf"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.phpcbf.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcbf.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs

phpcs hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.phpcs.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.settings.binPath

PHP_CodeSniffer binary path.

Type: null or string

Default:

"${tools.phpcs}/bin/phpcs"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.phpcs.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpcs.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan

phpstan hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.phpstan.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.settings.binPath

PHPStan binary path.

Type: null or string

Default:

"${tools.phpstan}/bin/phpstan"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.phpstan.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.phpstan.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier

prettier hook

Type: submodule

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.enable

Whether to enable this pre-commit hook.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.package

An optional package that provides the hook.

Type: null or package

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.always_run

if true this hook will run even if there are no matching files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.description

Description of the hook. Used for metadata purposes only.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.entry

The entry point - the executable to run. entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Type: string

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.excludes

Exclude files that were matched by these patterns.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.extraPackages

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Type: list of package

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.fail_fast

if true pre-commit will stop running hooks if this hook fails.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.files

The pattern of files to run on.

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.language

The language of the hook - tells pre-commit how to install the hook.

Type: string

Default: "system"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.name

The name of the hook. Shown during hook execution.

Type: string

Default: internal name, same as id

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.pass_filenames

Whether to pass filenames as arguments to the entry point.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.raw

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Type: attribute set of unspecified value

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.require_serial

if true this hook will execute using a single process instead of in parallel.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.settings.allow-parens

Include parentheses around a sole arrow function parameter.

Type: one of “always”, “avoid”

Default: "always"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.binPath

prettier binary path. E.g. if you want to use the prettier in node_modules, use ./node_modules/.bin/prettier.

Type: null or path

Default:

"${tools.prettier}/bin/prettier"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.bracket-same-line

Put > of opening tags on the last line instead of on a new line.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.cache

Only format changed files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.cache-location

Path to the cache file location used by --cache flag.

Type: string

Default: "./node_modules/.cache/prettier/.prettier-cache"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.cache-strategy

Strategy for the cache to use for detecting changed files.

Type: null or one of “metadata”, “content”

Default: null

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.check

Output a human-friendly message and a list of unformatted files, if any.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.color

Colorize error messages.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.config-precedence

Defines how config file should be evaluated in combination of CLI options.

Type: one of “cli-override”, “file-override”, “prefer-file”

Default: "cli-override"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.configPath

Path to a Prettier configuration file (.prettierrc, package.json, prettier.config.js).

Type: string

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.embedded-language-formatting

Control how Prettier formats quoted code embedded in the file.

Type: one of “auto”, “off”

Default: "auto"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.end-of-line

Which end of line characters to apply.

Type: one of “lf”, “crlf”, “cr”, “auto”

Default: "lf"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.html-whitespace-sensitivity

How to handle whitespaces in HTML.

Type: one of “css”, “strict”, “ignore”

Default: "css"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.ignore-path

Path to a file containing patterns that describe files to ignore. By default, prettier looks for ./.gitignore and ./.prettierignore. Multiple values are accepted.

Type: list of path

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.ignore-unknown

Ignore unknown files.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.insert-pragma

Insert @format pragma into file’s first docblock comment.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.jsx-single-quote

Use single quotes in JSX.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.list-different

Print the filenames of files that are different from Prettier formatting.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.log-level

What level of logs to report.

Type: one of “silent”, “error”, “warn”, “log”, “debug”

Default: "log"

Example: "debug"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.no-bracket-spacing

Do not print spaces between brackets.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.no-config

Do not look for a configuration file.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.no-editorconfig

Don’t take .editorconfig into account when parsing configuration.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.no-error-on-unmatched-pattern

Prevent errors when pattern is unmatched.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.no-semi

Do not print semicolons, except at the beginning of lines which may need them.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.parser

Which parser to use.

Type: one of “”, “flow”, “babel”, “babel-flow”, “babel-ts”, “typescript”, “acorn”, “espree”, “meriyah”, “css”, “less”, “scss”, “json”, “json5”, “json-stringify”, “graphql”, “markdown”, “mdx”, “vue”, “yaml”, “glimmer”, “html”, “angular”, “lwc”

Default: ""

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.plugins

Add plugins from paths.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.print-width

Line length that the printer will wrap on.

Type: signed integer

Default: 80

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.prose-wrap

When to or if at all hard wrap prose to print width.

Type: one of “always”, “never”, “preserve”

Default: "preserve"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.quote-props

Change when properties in objects are quoted.

Type: one of “as-needed”, “consistent”, “preserve”

Default: "as-needed"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.require-pragma

Require either ‘@prettier’ or ‘@format’ to be present in the file’s first docblock comment.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.single-attribute-per-line

Enforce single attribute per line in HTML, Vue andJSX.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.single-quote

Number of spaces per indentation-level.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.tab-width

Line length that the printer will wrap on.

Type: signed integer

Default: 2

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.trailing-comma

Print trailing commas wherever possible in multi-line comma-separated syntactic structures.

Type: one of “all”, “es5”, “none”

Default: "all"

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.use-tabs

Indent with tabs instead of spaces.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.vue-indent-script-and-style

Indent script and style tags in Vue files.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.with-node-modules

Process files inside ‘node_modules’ directory.

Type: boolean

Default: false

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.settings.write

Edit files in-place.

Type: boolean

Default: true

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix

pre-commit.hooks.prettier.stages

Confines the hook to run at a particular stage.

Type: list of (one of “commit-msg”, “post-checkout”, “post-commit”, “post-merge”, “post-rewrite”, “pre-commit”, “pre-merge-commit”, “pre-push”, “pre-rebase”, “prepare-commit-msg”, “manual”, “commit”, “push”, “merge-commit”)

Default: default_stages

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.types

List of file types to run on. See Filtering files with types.

Type: list of string

Default:

[
  "file"
]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.types_or

List of file types to run on, where only a single type needs to match.

Type: list of string

Default: [ ]

Declared by: - https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix

pre-commit.hooks.prettier.verbose

forces the output of the hook to be printed even when the hook passes.

Type: boolean

Default: false

Declared by: -