diff --git a/docs/reference/options.md b/docs/reference/options.md index e9226e39a..8d202d53e 100644 --- a/docs/reference/options.md +++ b/docs/reference/options.md @@ -1,41765 +1,3 @@ -# devenv.nix - -## 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](https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix) - - - -## android.enable - - - -Whether to enable tools for Android Development. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.abis - -The Android ABIs to install. -By default, the arm64-v8a and x86_64 ABIs are installed. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "arm64-v8a" - "x86_64" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.android-studio.enable - - - -Whether to enable the installation of Android Studio. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.android-studio.package - - - -The Android Studio package to use. -By default, the Android Studio package from nixpkgs is used. - - - -*Type:* -package - - - -*Default:* -` "pkgs.android-studio" ` - - - -*Example:* -` "pkgs.android-studio" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.buildTools.version - - - -The version of the Android build tools to install. -By default, version 30.0.3 is installed or \[ “33.0.2” “30.0.3” ] if flutter is enabled. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "34.0.0" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.cmake.version - - - -The CMake versions to install for Android. -By default, version 3.22.1 is installed. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "3.22.1" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.cmdLineTools.version - - - -The version of the Android command line tools to install. -By default, version 11.0 is installed or 8.0 if flutter is enabled. - - - -*Type:* -string - - - -*Default:* -` "11.0" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.emulator.enable - - - -Whether to include the Android Emulator. -By default, the emulator is included. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.emulator.version - - - -The version of the Android Emulator to install. -By default, version 34.1.9 is installed. - - - -*Type:* -string - - - -*Default:* -` "34.1.9" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.extraLicenses - - - -The additional Android licenses to accept. -By default, several standard licenses are accepted. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "android-sdk-preview-license" - "android-googletv-license" - "android-sdk-arm-dbt-license" - "google-gdk-license" - "intel-android-extra-license" - "intel-android-sysimage-license" - "mips-android-sysimage-license" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.extras - - - -The Android extras to install. -By default, the Google Cloud Messaging (GCM) extra is installed. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "extras;google;gcm" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.flutter.enable - - - -Whether to include the Flutter tools. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.flutter.package - - - -The Flutter package to use. -By default, the Flutter package from nixpkgs is used. - - - -*Type:* -package - - - -*Default:* -` "pkgs.flutter" ` - - - -*Example:* -` "pkgs.flutter" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.googleAPIs.enable - - - -Whether to use the Google APIs. -By default, the Google APIs are used. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.googleTVAddOns.enable - - - -Whether to use the Google TV Add-Ons. -By default, the Google TV Add-Ons are used. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.ndk.enable - - - -Whether to include the Android NDK (Native Development Kit). -By default, the NDK is included. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.ndk.version - - - -The version of the Android NDK (Native Development Kit) to install. -By default, version 26.1.10909125 is installed. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "26.1.10909125" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.platformTools.version - - - -The version of the Android platform tools to install. -By default, version 34.0.5 is installed or 34.0.5 if flutter is enabled. - - - -*Type:* -string - - - -*Default:* -` "34.0.5" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.platforms.version - - - -The Android platform versions to install. -By default, versions 32 and 34 are installed. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "32" - "34" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.reactNative.enable - - - -Whether to include the Flutter tools. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.sources.enable - - - -Whether to include the Android sources. -By default, the sources are not included. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.systemImageTypes - - - -The Android system image types to install. -By default, the google_apis_playstore system image is installed. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "google_apis_playstore" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.systemImages.enable - - - -Whether to include the Android system images. -By default, the system images are included. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix) - - - -## android.tools.version - - - -The version of the Android SDK tools to install. -By default, version 26.1.1 is installed. - - - -*Type:* -string - - - -*Default:* -` "26.1.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.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](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](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](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 -- aws `. -. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](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](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](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 -- opentofu `. -. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](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](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](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](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 -- terraform `. -. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix](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](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](https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix) - - - -## cachix.package - - - -The cachix package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.cachix ` - - - -*Example:* -` inputs.devenv.inputs.cachix.packages.${pkgs.stdenv.system}.cachix ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix](https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix) - - - -## cachix.pull - - - -What caches to pull from. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.enableLayerDeduplication - - - -Whether to enable layer deduplication using the approach described at https://blog.eigenvalue.net/2023-nix2container-everything-once/ -. - - - -*Type:* -boolean - - - -*Default:* -` true ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.copyToRoot - - - -Add a path to the container. Defaults to the whole git repo. - - - -*Type:* -path or list of path - - - -*Default:* -` "self" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.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](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.entrypoint - - - -Entrypoint of the container. - - - -*Type:* -list of anything - - - -*Default:* -` [ entrypoint ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.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](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers - - - -The layers to create. - - - -*Type:* -list of (submodule) - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.copyToRoot - - - -A list of derivations copied to the image root directory. - -Store path prefixes ` /nix/store/hash-path ` are removed in order to relocate them to the image ` / `. - - - -*Type:* -list of package - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.deps - - - -A list of store paths to include in the layer. - - - -*Type:* -list of package - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.ignore - - - -A store path to ignore when building the layer. This is mainly useful to ignore the configuration file from the container layer. - - - -*Type:* -null or path in the Nix store - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.maxLayers - - - -The maximum number of layers to create. - - - -*Type:* -signed integer - - - -*Default:* -` 1 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.perms - - - -A list of file permissions which are set when the tar layer is created. - -These permissions are not written to the Nix store. - - - -*Type:* -list of (submodule) - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.perms.\*.gid - - - -The group ID to apply to all of the files matched by the ` regex `. - - - -*Type:* -null or signed integer - - - -*Default:* -` null ` - - - -*Example:* -` "1000" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.perms.\*.gname - - - -The group name to apply to all of the files matched by the ` regex `. - - - -*Type:* -null or string - - - -*Default:* -` null ` - - - -*Example:* -` "root" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.perms.\*.mode - - - -The numeric permissions mode to apply to all of the files matched by the ` regex `. - - - -*Type:* -null or string - - - -*Default:* -` null ` - - - -*Example:* -` "644" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.perms.\*.path - - - -A store path. - - - -*Type:* -path in the Nix store - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.perms.\*.regex - - - -A regex pattern to select files or directories to apply the ` mode ` to. - - - -*Type:* -null or string - - - -*Default:* -` null ` - - - -*Example:* -` ".*" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.perms.\*.uid - - - -The user ID to apply to all of the files matched by the ` regex `. - - - -*Type:* -null or signed integer - - - -*Default:* -` null ` - - - -*Example:* -` "1000" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.perms.\*.uname - - - -The user name to apply to all of the files matched by the ` regex `. - - - -*Type:* -null or string - - - -*Default:* -` null ` - - - -*Example:* -` "root" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.layers.\*.reproducible - - - -Whether the layer should be reproducible. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/containers.nix](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.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](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.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](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.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](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.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](https://github.com/cachix/devenv/blob/main/src/modules/containers.nix) - - - -## containers.\.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](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](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix) - - - -## devenv.isTesting - - - -Whether the environment is being used for testing. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tests.nix](https://github.com/cachix/devenv/blob/main/src/modules/tests.nix) - - - -## devenv.latestVersion - - - -The latest version of devenv. - - - -*Type:* -string - - - -*Default:* -` "1.3.0" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix](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](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix) - - - -## hostsProfileName - - - -Profile name to use. - - - -*Type:* -string - - - -*Default:* -` "devenv-" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix) - - - -## languages.c.debugger - - - -An optional debugger package to use with c. -The default is ` gdb `, if supported on the current system. - - - -*Type:* -null or package - - - -*Default:* -` pkgs.gdb ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix) - - - -## languages.deno.package - - - -Which package of Deno to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.deno ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix) - - - -## languages.go.enableHardeningWorkaround - - - -Enable hardening workaround required for Delve debugger (https://github.com/go-delve/delve/issues/3085) - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix](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](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](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](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](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](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](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](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](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](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](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](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](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_headless = cfg.jdk.package; }" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix](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](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](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](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](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](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](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](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](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:* -` languages.javascript.package ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix](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](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](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](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix) - - - -## languages.lean4.enable - - - -Whether to enable tools for lean4 development. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix) - - - -## languages.lean4.package - - - -The lean4 package to use. - - - -*Type:* -package - - - -*Default:* -` "pkgs.lean4" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.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](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](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix) - - - -## languages.odin.debugger - - - -An optional debugger package to use with odin. -The default is ` gdb `, if supported on the current system. - - - -*Type:* -null or package - - - -*Default:* -` pkgs.gdb ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix) - - - -## languages.php.package - - - -Allows you to [override the default used package](https://nixos.org/manual/nixpkgs/stable/\#ssec-php-user-guide) -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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix) - - - -## languages.php.fpm.pools.\.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](https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix) - - - -## languages.php.fpm.pools.\.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](https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix) - - - -## languages.php.fpm.pools.\.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](https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix) - - - -## languages.php.fpm.pools.\.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](https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix) - - - -## languages.php.fpm.pools.\.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](https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix) - - - -## languages.php.fpm.pools.\.settings - - - -PHP-FPM pool directives. Refer to the “List of pool directives” section of -[https://www.php.net/manual/en/install.fpm.configuration.php"](https://www.php.net/manual/en/install.fpm.configuration.php%22) -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](https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix) - - - -## languages.php.fpm.pools.\.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:* -` config.env.DEVENV_STATE + "/php-fpm/.sock" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix](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](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 = config.env.DEVENV_STATE + "/php-fpm/php-fpm.log"; -} - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix](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](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](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](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](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](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](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](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:* - -``` -[ "${config.devenv.dotfile}/profile" ] - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix) - - - -## languages.python.uv.sync.enable - - - -Whether to enable uv sync during devenv initialisation. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix) - - - -## languages.python.uv.sync.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](https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix) - - - -## languages.python.uv.sync.extras - - - -Which extras to install. See ` --extra `. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix](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](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](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](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](https://github.com/cachix/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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix) - - - -## languages.r.radian.enable - - - -Whether to enable a 21 century R console. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix) - - - -## languages.r.radian.package - - - -The radian package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.radianWrapper ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix](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](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](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](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](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](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](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](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](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](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](https://github.com/bobvanderlinden/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](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](https://github.com/bobvanderlinden/nixpkgs-ruby). -When the ` .ruby-version ` file exists in the same directory as the devenv configuration, you can use: - -```nix -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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix) - - - -## languages.rust.components - - - -List of [Rustup components](https://rust-lang.github.io/rustup/concepts/components.html) -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](https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix) - - - -## languages.rust.mold.enable - - - -Enable mold as the linker. - -Enabled by default on x86_64 Linux machines when no cross-compilation targets are specified. - - - -*Type:* -boolean - - - -*Default:* -` pkgs.stdenv.isLinux && pkgs.stdenv.isx86_64 && languages.rust.targets == [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix) - - - -## languages.rust.targets - - - -List of extra [targets](https://github.com/nix-community/fenix\#supported-platforms-and-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](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix) - - - -## languages.scala.mill.enable - - - -Whether to enable mill, a simplified, fast build tool for Scala. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix) - - - -## languages.scala.mill.package - - - -The mill package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.mill ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix) - - - -## languages.scala.sbt.enable - - - -Whether to enable sbt, the standard build tool for Scala. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix) - - - -## languages.scala.sbt.package - - - -The sbt package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.sbt ` - - - -*Example:* -` sbt-with-scala-native ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix](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](https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix) - - - -## languages.solidity.enable - - - -Whether to enable tools for Solidity development. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix) - - - -## languages.solidity.package - - - -Which compiler of Solidity to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.elixir ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix) - - - -## languages.solidity.foundry.enable - - - -Whether to enable install Foundry. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix) - - - -## languages.solidity.foundry.package - - - -Which Foundry package to use. - - - -*Type:* -package - - - -*Default:* -` foundry.defaultPackage.$${pkgs.stdenv.system} ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.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](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](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](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](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](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](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](https://github.com/stackbuilders/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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix) - - - -## outputs - - - -Nix outputs for ` devenv build ` consumption. - - - -*Type:* -outputOf (attribute set) - - - -*Default:* - -``` -{ - foo = { - ncdu = ; - }; - git = ; -} -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/outputs.nix](https://github.com/cachix/devenv/blob/main/src/modules/outputs.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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix) - - - -## pre-commit.addGcRoot - - - -Whether to add the generated pre-commit-config.yaml to the garbage collector roots. -This prevents Nix from garbage-collecting the tools used by hooks. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix](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](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](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](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: - -```nix -hooks.nixpkgs-fmt.enable = true; -``` - -Example of a custom hook: - -```nix -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 - -**` biome `** - -A toolchain for web projects, aimed to provide functionalities to maintain them - -**` black `** - -The uncompromising Python code formatter - -**` cabal-fmt `** - -Format Cabal files - -**` cabal-gild `** - -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 (classic). - -**` nixfmt-classic `** - -Nix code prettifier (classic). - -**` nixfmt-rfc-style `** - -Nix code prettifier (RFC 166 style). - -**` 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. - -**` reuse `** - -reuse is a tool for compliance with the REUSE recommendations. - -**` revive `** - -A linter for Go source code. - -**` ripsecrets `** - -Prevent committing secret keys into your source code - -**` rome `** - -A toolchain for web projects, aimed to provide functionalities to maintain them - -**` ruff `** - -An extremely fast Python linter, written in Rust. - -**` ruff-format `** - -An extremely fast Python code formatter, 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. - -**` terraform-validate `** - -Validates terraform configuration files (` .tf `). - -**` 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. - -**` trufflehog `** - -Secrets scanner - -**` typos `** - -Source code spell checker - -**` typstfmt `** - -format typst - -**` typstyle `** - -Beautiful and reliable typst code formatter - -**` vale `** - -A markup-aware linter for prose built with speed and extensibility in mind. - -**` yamlfmt `** - -Formatter for YAML files. - -**` 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/hooks.nix) - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.types - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.\.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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.alejandra.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.alejandra.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ansible-lint.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ansible-lint.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.autoflake.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.autoflake.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome - - - -biome hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.settings.binPath - - - -` biome ` binary path. E.g. if you want to use the ` biome ` in ` node_modules `, use ` ./node_modules/.bin/biome `. - - - -*Type:* -null or path - - - -*Default:* -` "\${tools.biome}/bin/biome" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.biome.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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.black.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.black.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html\#command-line-options). - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` "--skip-magic-trailing-comma" ` - -*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/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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.clippy.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.clippy.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.cmake-format.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.cmake-format.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.credo.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.credo.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.deadnix.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.deadnix.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.denofmt.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.denofmt.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.denolint.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.denolint.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.dune-fmt.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.dune-fmt.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.eclint.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.eclint.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.eslint.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.eslint.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.flake8.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.flake8.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.flynt.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.flynt.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.headache.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.headache.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.hlint.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.hlint.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.hpack.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.hpack.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.isort.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.isort.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](https://pycqa.github.io/isort/docs/configuration/options.html). - - - -*Type:* -string - - - -*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/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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.lacheck.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.lacheck.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.latexindent.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.latexindent.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](https://latexindentpl.readthedocs.io/en/latest/sec-how-to-use.html\#from-the-command-line) - - - -*Type:* -string - - - -*Default:* -` "--local --silent --overwriteIfDifferent" ` - -*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/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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.lua-ls.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.lua-ls.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.lychee.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.lychee.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](https://lychee.cli.rs/\#/usage/cli). - - - -*Type:* -string - - - -*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/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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.markdownlint.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.markdownlint.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.mdl.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.mdl.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.mkdocs-linkcheck.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.mkdocs-linkcheck.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.mypy.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.mypy.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic - - - -nixfmt (classic) hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-classic.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style - - - -nixfmt (RFC 166 style) hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.nixfmt-rfc-style.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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.no-commit-to-branch.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.no-commit-to-branch.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ormolu.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ormolu.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.php-cs-fixer.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.php-cs-fixer.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.phpcbf.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.phpcbf.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.phpcs.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.phpcs.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.phpstan.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.phpstan.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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](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](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](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.prettier.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.prettier.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](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](https://pre-commit.com/\#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](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](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:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm - - - -psalm hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.settings.binPath - - - -Psalm binary path. - - - -*Type:* -null or string - - - -*Default:* - -``` -"${tools.psalm}/bin/psalm" - -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.psalm.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint - - - -pylint hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.settings.binPath - - - -Pylint binary path. Should be used to specify Pylint binary from your Nix-managed Python environment. - - - -*Type:* -null or string - - - -*Default:* - -``` -"${tools.pylint}/bin/pylint" - -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.pylint.settings.reports - - - -Whether to display a full report. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.pylint.settings.score - - - -Whether to activate the evaluation score. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*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/hooks.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pylint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright - - - -pyright hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.settings.binPath - - - -Pyright binary path. Should be used to specify the pyright executable in an environment containing your typing stubs. - - - -*Type:* -null or string - - - -*Default:* - -``` -"${tools.pyright}/bin/pyright" - -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyright.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade - - - -pyupgrade hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.settings.binPath - - - -pyupgrade binary path. Should be used to specify the pyupgrade binary from your Nix-managed Python environment. - - - -*Type:* -null or string - - - -*Default:* - -``` -"${tools.pyupgrade}/bin/pyupgrade" - -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.pyupgrade.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse - - - -reuse hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.settings.flags - - - -Flags passed to reuse. For available options run ‘reuse lint --help’ - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` "--json" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.reuse.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive - - - -revive hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.settings.configPath - - - -Path to the configuration TOML file. - - - -*Type:* -string - - - -*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/hooks.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.revive.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets - - - -ripsecrets hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.settings.additionalPatterns - - - -Additional regex patterns used to find secrets. If there is a matching group in the regex the matched group will be tested for randomness before being reported as a secret. - - - -*Type:* -list of string - - - -*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/hooks.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.ripsecrets.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt - - - -Additional rustfmt settings - -Override the ` rustfmt ` and ` cargo ` packages by setting ` hooks.rustfmt.packageOverrides `. - -``` -hooks.rustfmt.packageOverrides.cargo = pkgs.cargo; -hooks.rustfmt.packageOverrides.rustfmt = pkgs.rustfmt; -``` - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.packageOverrides.cargo - - - -The cargo package to use. - - - -*Type:* -package - -*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/hooks.nix) - - - -## pre-commit.hooks.rustfmt.packageOverrides.rustfmt - - - -The rustfmt package to use. - - - -*Type:* -package - -*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/hooks.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.rustfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt - - - -shfmt hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.settings.simplify - - - -Simplify the code. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*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/hooks.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.shfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents - - - -sort-file-contents-hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.settings.ignore-case - - - -Fold lower case to upper case characters. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.sort-file-contents.settings.unique - - - -Ensure each line is unique. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.sort-file-contents.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix - - - -statix hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.settings.format - - - -Error Output format. - - - -*Type:* -one of “stderr”, “errfmt”, “json” - - - -*Default:* -` "errfmt" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.statix.settings.ignore - - - -Globs of file patterns to skip. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "flake.nix" - "_*" -] -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.statix.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt - - - -Treefmt hook. - -Include any additional formatters configured by treefmt as ` hooks.treefmt.settings.formatters `. - -``` -hooks.treefmt.settings.formatters = [ - pkgs.nixpkgs-fmt - pkgs.black -]; -``` - -Override ` treefmt ` itself by setting ` hooks.treefmt.packageOverrides.treefmt `. - -``` -hooks.treefmt.packageOverrides.treefmt = pkgs.treefmt; -``` - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.packageOverrides.treefmt - - - -The treefmt package to use - - - -*Type:* -package - -*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/hooks.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.settings.formatters - - - -The formatter packages configured by treefmt - - - -*Type:* -list of package - - - -*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/hooks.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.treefmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos - - - -typos hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.settings.binary - - - -Whether to search binary files. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.color - - - -When to use generate output. - - - -*Type:* -one of “auto”, “always”, “never” - - - -*Default:* -` "auto" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.configPath - - - -Path to a custom config file. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` ".typos.toml" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.configuration - - - -Multiline-string configuration passed as config file. If set, config set in ` typos.settings.configPath ` gets ignored. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - [files] - ignore-dot = true - - [default] - binary = false - - [type.py] - extend-glob = [] -'' -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.diff - - - -Print a diff of what would change. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.exclude - - - -Ignore files and directories matching the glob. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` "*.nix" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.format - - - -Output format to use. - - - -*Type:* -one of “silent”, “brief”, “long”, “json” - - - -*Default:* -` "long" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.hidden - - - -Search hidden files and directories. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.ignored-words - - - -Spellings and words to ignore. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "MQTT" - "mosquitto" -] -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.locale - - - -Which language to use for spell checking. - - - -*Type:* -one of “en”, “en-us”, “en-gb”, “en-ca”, “en-au” - - - -*Default:* -` "en" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.no-check-filenames - - - -Skip verifying spelling in file names. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.no-check-files - - - -Skip verifying spelling in files. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.no-unicode - - - -Only allow ASCII characters in identifiers. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.quiet - - - -Less output per occurrence. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.verbose - - - -More output per occurrence. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.settings.write - - - -Fix spelling in files by writing them. Cannot be used with ` typos.settings.diff `. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*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/hooks.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.typos.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale - - - -vale hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix) - - - -## pre-commit.hooks.vale.settings.configuration - - - -Multiline-string configuration passed as config file. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - MinAlertLevel = suggestion - [*] - BasedOnStyles = Vale -'' -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.vale.settings.flags - - - -Flags passed to vale. - - - -*Type:* -string - - - -*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/hooks.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.vale.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt - - - -yamlfmt hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.settings.configPath - - - -Path to a custom configuration file. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` ".yamlfmt" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamlfmt.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint - - - -yamllint hook - - - -*Type:* -submodule - -*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/hooks.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.args - - - -List of additional parameters to pass to the hook. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.exclude_types - - - -List of file types to exclude. See [Filtering files with types](https://pre-commit.com/\#filtering-files-with-types). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.settings.configData - - - -Serialized YAML object describing the configuration. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` "{extends: relaxed, rules: {line-length: {max: 120}}}" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.yamllint.settings.configPath - - - -Path to a custom configuration file. - - - -*Type:* -string - - - -*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/hooks.nix) - - - -## pre-commit.hooks.yamllint.settings.configuration - - - -Multiline-string configuration passed as config file. If set, configuration file set in ` yamllint.settings.configPath ` gets ignored. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - --- - - extends: relaxed - - rules: - indentation: enable -'' -``` - -*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/hooks.nix) - - - -## pre-commit.hooks.yamllint.settings.format - - - -Format for parsing output. - - - -*Type:* -one of “parsable”, “standard”, “colored”, “github”, “auto” - - - -*Default:* -` "auto" ` - -*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/hooks.nix) - - - -## pre-commit.hooks.yamllint.settings.preset - - - -The configuration preset to use. - - - -*Type:* -one of “default”, “relaxed” - - - -*Default:* -` "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/hooks.nix) - - - -## pre-commit.hooks.yamllint.settings.strict - - - -Return non-zero exit code on warnings as well as errors. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*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/hooks.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.types - - - -List of file types to run on. See [Filtering files with types](https://pre-commit.com/\#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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.hooks.yamllint.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](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hook.nix) - - - -## pre-commit.installationScript - - - -A bash snippet that installs nix-pre-commit-hooks in the current directory - - - -*Type:* -string *(read only)* - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix) - - - -## pre-commit.rootSrc - - - -The source of the project to be checked. - -This is used in the derivation that performs the check. - -If you use the ` flakeModule `, the default is ` self.outPath `; the whole flake -sources. - - - -*Type:* -path - - - -*Default:* -` gitignoreSource config.src ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix) - - - -## pre-commit.run - - - -A derivation that tests whether the pre-commit hooks run cleanly on -the entire project. - - - -*Type:* -package *(read only)* - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix) - - - -## pre-commit.settings.rust.cargoManifestPath - - - -Path to Cargo.toml - - - -*Type:* -null or string - - - -*Default:* -` null ` - -*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/hooks.nix) - - - -## pre-commit.src - - - -Root of the project. By default this will be filtered with the ` gitignoreSource ` -function later, unless ` rootSrc ` is specified. - -If you use the ` flakeModule `, the default is ` self.outPath `; the whole flake -sources. - - - -*Type:* -path - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix) - - - -## pre-commit.tools - - - -Tool set from which ` nix-pre-commit-hooks ` will pick binaries. - -` nix-pre-commit-hooks ` comes with its own set of packages for this purpose. - - - -*Type:* -lazy attribute set of (null or package) - - - -*Default:* -` git-hooks.nix-pkgs.callPackage tools-dot-nix { inherit (pkgs) system; } ` - -*Declared by:* - - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/pre-commit.nix) - - - -## process.manager.after - - - -Bash code to execute after stopping processes. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) - - - -## process.manager.args - - - -Additional arguments to pass to the process manager. - - - -*Type:* -attribute set - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) - - - -## process.manager.before - - - -Bash code to execute before starting processes. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) - - - -## process.manager.implementation - - - -The process manager to use when running processes with ` devenv up `. - - - -*Type:* -one of “hivemind”, “honcho”, “overmind”, “process-compose” - - - -*Default:* -` "process-compose" ` - - - -*Example:* -` "overmind" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) - - - -## process.managers.hivemind.package - - - -The hivemind package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.hivemind ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix) - - - -## process.managers.honcho.package - - - -The honcho package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.honcho ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix) - - - -## process.managers.overmind.package - - - -The overmind package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.overmind ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix) - - - -## process.managers.process-compose.package - - - -The process-compose package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.process-compose ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) - - - -## process.managers.process-compose.port - - - -The port to bind the process-compose server to. - -Not used when ` unixSocket.enable ` is true. - - - -*Type:* -signed integer - - - -*Default:* -` 8080 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) - - - -## process.managers.process-compose.settings - - - -Top-level process-compose.yaml options - -Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\` - - - -*Type:* -YAML value - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - availability = { - backoff_seconds = 2; - max_restarts = 5; - restart = "on_failure"; - }; - depends_on = { - some-other-process = { - condition = "process_completed_successfully"; - }; - }; - environment = [ - "ENVVAR_FOR_THIS_PROCESS_ONLY=foobar" - ]; -} -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) - - - -## process.managers.process-compose.tui.enable - - - -Enable the TUI (Terminal User Interface) - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) - - - -## process.managers.process-compose.unixSocket.enable - - - -Whether to enable running the process-compose server over unix domain sockets instead of tcp. - - - -*Type:* -boolean - - - -*Default:* -` true ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) - - - -## process.managers.process-compose.unixSocket.path - - - -Override the path to the unix socket. - - - -*Type:* -string - - - -*Default:* -` ${config.devenv.runtime}/pc.sock ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) - - - -## processes - - - -Processes can be started with ` devenv up ` and run in the foreground. - - - -*Type:* -attribute set of (submodule) - - - -*Default:* -` { } ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) - - - -## processes.\.exec - - - -Bash code to run the process. - - - -*Type:* -string - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) - - - -## processes.\.process-compose - - - -process-compose.yaml specific process attributes. - -Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\` - -Only used when using ` process.manager.implementation = "process-compose"; ` - - - -*Type:* -attribute set - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - availability = { - backoff_seconds = 2; - max_restarts = 5; - restart = "on_failure"; - }; - depends_on = { - some-other-process = { - condition = "process_completed_successfully"; - }; - }; - environment = [ - "ENVVAR_FOR_THIS_PROCESS_ONLY=foobar" - ]; -} -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) - - - -## scripts - - - -A set of scripts available when the environment is active. - - - -*Type:* -attribute set of (submodule) - - - -*Default:* -` { } ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix](https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix) - - - -## scripts.\.package - - - -The package to use to run the script. - - - -*Type:* -package - - - -*Default:* -` ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix](https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix) - - - -## scripts.\.binary - - - -Override the binary name if it doesn’t match package name - - - -*Type:* -string - - - -*Default:* -` "bash" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix](https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix) - - - -## scripts.\.description - - - -Description of the script. - - - -*Type:* -string - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix](https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix) - - - -## scripts.\.exec - - - -Shell code to execute when the script is run. - - - -*Type:* -string - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix](https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix) - - - -## services.adminer.enable - - - -Whether to enable Adminer process. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix) - - - -## services.adminer.package - - - -Which package of Adminer to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.adminer ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix) - - - -## services.adminer.listen - - - -Listen address for the Adminer. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:8080" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix) - - - -## services.blackfire.enable - - - -Whether to enable Blackfire profiler agent - -It automatically installs Blackfire PHP extension. -. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix) - - - -## services.blackfire.enableApm - - - -Whether to enable Enables application performance monitoring, requires special subscription. -. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix) - - - -## services.blackfire.package - - - -Which package of blackfire to use - - - -*Type:* -package - - - -*Default:* -` pkgs.blackfire ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix) - - - -## services.blackfire.client-id - - - -Sets the client id used to authenticate with Blackfire. -You can find your personal client-id at [https://blackfire.io/my/settings/credentials](https://blackfire.io/my/settings/credentials). - - - -*Type:* -string - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix) - - - -## services.blackfire.client-token - - - -Sets the client token used to authenticate with Blackfire. -You can find your personal client-token at [https://blackfire.io/my/settings/credentials](https://blackfire.io/my/settings/credentials). - - - -*Type:* -string - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix) - - - -## services.blackfire.server-id - - - -Sets the server id used to authenticate with Blackfire. -You can find your personal server-id at [https://blackfire.io/my/settings/credentials](https://blackfire.io/my/settings/credentials). - - - -*Type:* -string - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix) - - - -## services.blackfire.server-token - - - -Sets the server token used to authenticate with Blackfire. -You can find your personal server-token at [https://blackfire.io/my/settings/credentials](https://blackfire.io/my/settings/credentials). - - - -*Type:* -string - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix) - - - -## services.blackfire.socket - - - -Sets the server socket path - - - -*Type:* -string - - - -*Default:* -` "tcp://127.0.0.1:8307" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix) - - - -## services.caddy.enable - - - -Whether to enable Caddy web server. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.package - - - -Caddy package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.caddy ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.adapter - - - -Name of the config adapter to use. -See [https://caddyserver.com/docs/config-adapters](https://caddyserver.com/docs/config-adapters) for the full list. - - - -*Type:* -string - - - -*Default:* -` "caddyfile" ` - - - -*Example:* -` "nginx" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.ca - - - -Certificate authority ACME server. The default (Let’s Encrypt -production server) should be fine for most people. Set it to null if -you don’t want to include any authority (or if you want to write a more -fine-graned configuration manually). - - - -*Type:* -null or string - - - -*Default:* -` "https://acme-v02.api.letsencrypt.org/directory" ` - - - -*Example:* -` "https://acme-staging-v02.api.letsencrypt.org/directory" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.config - - - -Verbatim Caddyfile to use. - -Refer to [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile) -for more information. - -Caddy v2 supports multiple config formats via adapters (see [` services.caddy.adapter `](\#servicescaddyconfig)). - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - # Global options block - { - debug - } - - # Site block - example.com { - encode gzip - log - root /srv/http - } -'' -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.dataDir - - - -The data directory, for storing certificates. Before 17.09, this -would create a .caddy directory. With 17.09 the contents of the -.caddy directory are in the specified data directory instead. -Caddy v2 replaced CADDYPATH with XDG directories. -See [https://caddyserver.com/docs/conventions\#file-locations](https://caddyserver.com/docs/conventions\#file-locations). - - - -*Type:* -path - - - -*Default:* -` "${config.env.DEVENV_STATE}/caddy" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.email - - - -Email address (for Let’s Encrypt certificate). - - - -*Type:* -string - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.resume - - - -Use saved config, if any (and prefer over configuration passed with [` caddy.config `](\#caddyconfig)). - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.virtualHosts - - - -Declarative vhost config. - - - -*Type:* -attribute set of (submodule) - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - "hydra.example.com" = { - serverAliases = [ "www.hydra.example.com" ]; - extraConfig = '''' - encode gzip - log - root /srv/http - ''''; - }; -}; - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.virtualHosts.\.extraConfig - - - -These lines go into the vhost verbatim. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.caddy.virtualHosts.\.serverAliases - - - -Additional names of virtual hosts served by this virtual host configuration. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "www.example.org" - "example.org" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix) - - - -## services.cassandra.enable - - - -Whether to enable Add Cassandra process script… - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix) - - - -## services.cassandra.package - - - -Which version of Cassandra to use - - - -*Type:* -package - - - -*Default:* -` pkgs.cassandra_4 ` - - - -*Example:* -` pkgs.cassandra_4; ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix) - - - -## services.cassandra.allowClients - - - -Enables or disables the native transport server (CQL binary protocol) - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix) - - - -## services.cassandra.clusterName - - - -The name of the cluster - - - -*Type:* -string - - - -*Default:* -` "Test Cluster" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix) - - - -## services.cassandra.extraConfig - - - -Extra options to be merged into ` cassandra.yaml ` as nix attribute set. - - - -*Type:* -attribute set - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - commitlog_sync_batch_window_in_ms = 3; -} -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix) - - - -## services.cassandra.jvmOpts - - - -Options to pass to the JVM through the JVM_OPTS environment variable - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix) - - - -## services.cassandra.listenAddress - - - -Listen address - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - - - -*Example:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix) - - - -## services.cassandra.seedAddresses - - - -The addresses of hosts designated as contact points of the cluster - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "127.0.0.1" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix) - - - -## services.clickhouse.enable - - - -Whether to enable clickhouse-server. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix) - - - -## services.clickhouse.package - - - -Which package of clickhouse to use - - - -*Type:* -package - - - -*Default:* -` pkgs.clickhouse ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix) - - - -## services.clickhouse.config - - - -ClickHouse configuration in YAML. - - - -*Type:* -strings concatenated with “\\n” - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix) - - - -## services.clickhouse.httpPort - - - -Which http port to run clickhouse on - - - -*Type:* -signed integer - - - -*Default:* -` 8123 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix) - - - -## services.clickhouse.port - - - -Which port to run clickhouse on - - - -*Type:* -signed integer - - - -*Default:* -` 9000 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix) - - - -## services.cockroachdb.enable - - - -Whether to enable Add CockroachDB process. -. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix) - - - -## services.cockroachdb.package - - - -The CockroachDB package to use. - - - -*Type:* -unspecified value - - - -*Default:* -` "pkgs.cockroachdb-bin" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix) - - - -## services.cockroachdb.http_addr - - - -The hostname or IP address to bind to for HTTP requests. - - - -*Type:* -string - - - -*Default:* -` "localhost:8080" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix) - - - -## services.cockroachdb.listen_addr - - - -The address/hostname and port to listen on. - - - -*Type:* -string - - - -*Default:* -` "localhost:26257" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix) - - - -## services.couchdb.enable - - - -Whether to enable CouchDB process. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.package - - - -Which version of CouchDB to use - - - -*Type:* -package - - - -*Default:* -` pkgs.couchdb3 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.baseDir - - - -The directory where CouchDB will store its data. - - - -*Type:* -string *(read only)* - - - -*Default:* -` config.env.DEVENV_STATE + "/couchdb" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.settings - - - -CouchDB configuration. -to know more about all settings, look at: -\ - - - -*Type:* -attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string)) - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - couchdb = { - database_dir = baseDir; - single_node = true; - view_index_dir = baseDir; - uri_file = "${config.services.couchdb.baseDir}/couchdb.uri"; - }; - admins = { - "admin_username" = "pass"; - }; - chttpd = { - bind_address = "127.0.0.1"; - port = 5984; - }; -} - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.settings.chttpd.bind_address - - - -Defines the IP address by which CouchDB will be accessible. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.settings.chttpd.port - - - -Defined the port number to listen. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 5984 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.settings.couchdb.database_dir - - - -Specifies location of CouchDB database files (\*.couch named). This -location should be writable and readable for the user the CouchDB -service runs as (couchdb by default). - - - -*Type:* -path - - - -*Default:* -` config.env.DEVENV_STATE + "/couchdb" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.settings.couchdb.single_node - - - -When this configuration setting is set to true, automatically create -the system databases on startup. Must be set false for a clustered -CouchDB installation. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.settings.couchdb.uri_file - - - -This file contains the full URI that can be used to access this -instance of CouchDB. It is used to help discover the port CouchDB is -running on (if it was set to 0 (e.g. automatically assigned any free -one). This file should be writable and readable for the user that -runs the CouchDB service (couchdb by default). - - - -*Type:* -path - - - -*Default:* -` config.env.DEVENV_STATE + "/couchdb"/couchdb.uri ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.couchdb.settings.couchdb.view_index_dir - - - -Specifies location of CouchDB view index files. This location should -be writable and readable for the user that runs the CouchDB service -(couchdb by default). - - - -*Type:* -path - - - -*Default:* -` config.env.DEVENV_STATE + "/couchdb" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix) - - - -## services.dynamodb-local.enable - - - -Whether to enable DynamoDB Local. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix) - - - -## services.dynamodb-local.package - - - -Which package of DynamoDB to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.dynamodb-local ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix) - - - -## services.dynamodb-local.port - - - -Listen address for the Dynamodb-local. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 8000 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix) - - - -## services.elasticmq.enable - - - -Whether to enable elasticmq-server. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix) - - - -## services.elasticmq.package - - - -Which package of elasticmq-server-bin to use - - - -*Type:* -package - - - -*Default:* -` pkgs.elasticmq-server-bin ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix) - - - -## services.elasticmq.settings - - - -Configuration for elasticmq-server - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix) - - - -## services.elasticsearch.enable - - - -Whether to enable elasticsearch. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.package - - - -Elasticsearch package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.elasticsearch7 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.cluster_name - - - -Elasticsearch name that identifies your cluster for auto-discovery. - - - -*Type:* -string - - - -*Default:* -` "elasticsearch" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.extraCmdLineOptions - - - -Extra command line options for the elasticsearch launcher. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.extraConf - - - -Extra configuration for elasticsearch. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - node.name: "elasticsearch" - node.master: true - node.data: false -'' -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.extraJavaOptions - - - -Extra command line options for Java. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "-Djava.net.preferIPv4Stack=true" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.listenAddress - - - -Elasticsearch listen address. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.logging - - - -Elasticsearch logging configuration. - - - -*Type:* -string - - - -*Default:* - -``` -'' - logger.action.name = org.elasticsearch.action - logger.action.level = info - appender.console.type = Console - appender.console.name = console - appender.console.layout.type = PatternLayout - appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n - rootLogger.level = info - rootLogger.appenderRef.console.ref = console -'' -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.plugins - - - -Extra elasticsearch plugins - - - -*Type:* -list of package - - - -*Default:* -` [ ] ` - - - -*Example:* -` [ pkgs.elasticsearchPlugins.discovery-ec2 ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.port - - - -Elasticsearch port to listen for HTTP traffic. - - - -*Type:* -signed integer - - - -*Default:* -` 9200 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.single_node - - - -Start a single-node cluster - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.elasticsearch.tcp_port - - - -Elasticsearch port for the node to node communication. - - - -*Type:* -signed integer - - - -*Default:* -` 9300 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix) - - - -## services.httpbin.enable - - - -Whether to enable httpbin. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix) - - - -## services.httpbin.bind - - - -Addresses for httpbin to listen on. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "127.0.0.1:8080" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix) - - - -## services.httpbin.extraArgs - - - -Gunicorn CLI arguments for httpbin. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix) - - - -## services.influxdb.enable - - - -Whether to enable influxdb. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix) - - - -## services.influxdb.package - - - -An open-source distributed time series database - - - -*Type:* -package - - - -*Default:* -` pkgs.influxdb ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix) - - - -## services.influxdb.config - - - -Configuration for InfluxDB-server - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix) - - - -## services.mailhog.enable - - - -Whether to enable mailhog process. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix) - - - -## services.mailhog.package - - - -Which package of mailhog to use - - - -*Type:* -package - - - -*Default:* -` pkgs.mailhog ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix) - - - -## services.mailhog.additionalArgs - - - -Additional arguments passed to ` mailhog `. - - - -*Type:* -list of strings concatenated with “\\n” - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "-invite-jim" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix) - - - -## services.mailhog.apiListenAddress - - - -Listen address for API. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:8025" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix) - - - -## services.mailhog.smtpListenAddress - - - -Listen address for SMTP. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:1025" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix) - - - -## services.mailhog.uiListenAddress - - - -Listen address for UI. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:8025" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix) - - - -## services.mailpit.enable - - - -Whether to enable mailpit process. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix) - - - -## services.mailpit.package - - - -Which package of mailpit to use - - - -*Type:* -package - - - -*Default:* -` pkgs.mailpit ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix) - - - -## services.mailpit.additionalArgs - - - -Additional arguments passed to ` mailpit `. - - - -*Type:* -list of strings concatenated with “\\n” - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "--max=500" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix) - - - -## services.mailpit.smtpListenAddress - - - -Listen address for SMTP. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:1025" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix) - - - -## services.mailpit.uiListenAddress - - - -Listen address for UI. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:8025" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix) - - - -## services.meilisearch.enable - - - -Whether to enable Meilisearch. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix) - - - -## services.meilisearch.environment - - - -Defines the running environment of Meilisearch. - - - -*Type:* -one of “development”, “production” - - - -*Default:* -` "development" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix) - - - -## services.meilisearch.listenAddress - - - -Meilisearch listen address. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix) - - - -## services.meilisearch.listenPort - - - -Meilisearch port to listen on. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 7700 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix) - - - -## services.meilisearch.logLevel - - - -Defines how much detail should be present in Meilisearch’s logs. -Meilisearch currently supports four log levels, listed in order of increasing verbosity: - - - ‘ERROR’: only log unexpected events indicating Meilisearch is not functioning as expected - - ‘WARN:’ log all unexpected events, regardless of their severity - - ‘INFO:’ log all events. This is the default value - - ‘DEBUG’: log all events and including detailed information on Meilisearch’s internal processes. - Useful when diagnosing issues and debugging - - - -*Type:* -string - - - -*Default:* -` "INFO" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix) - - - -## services.meilisearch.maxIndexSize - - - -Sets the maximum size of the index. -Value must be given in bytes or explicitly stating a base unit. -For example, the default value can be written as 107374182400, ‘107.7Gb’, or ‘107374 Mb’. -Default is 100 GiB - - - -*Type:* -string - - - -*Default:* -` "107374182400" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix) - - - -## services.meilisearch.noAnalytics - - - -Deactivates analytics. -Analytics allow Meilisearch to know how many users are using Meilisearch, -which versions and which platforms are used. -This process is entirely anonymous. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix) - - - -## services.memcached.enable - - - -Whether to enable memcached process. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix) - - - -## services.memcached.package - - - -Which package of memcached to use - - - -*Type:* -package - - - -*Default:* -` pkgs.memcached ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix) - - - -## services.memcached.bind - - - -The IP interface to bind to. -` null ` means “all interfaces”. - - - -*Type:* -null or string - - - -*Default:* -` "127.0.0.1" ` - - - -*Example:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix) - - - -## services.memcached.port - - - -The TCP port to accept connections. -If port 0 is specified memcached will not listen on a TCP socket. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 11211 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix) - - - -## services.memcached.startArgs - - - -Additional arguments passed to ` memcached ` during startup. - - - -*Type:* -list of strings concatenated with “\\n” - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "--memory-limit=100M" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix) - - - -## services.minio.enable - - - -Whether to enable MinIO Object Storage. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.package - - - -MinIO package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.minio ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.accessKey - - - -Access key of 5 to 20 characters in length that clients use to access the server. - - - -*Type:* -string - - - -*Default:* -` "minioadmin" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.afterStart - - - -Bash code to execute after minio is running. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - mc anonymous set download local/mybucket -'' -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.browser - - - -Enable or disable access to web UI. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.buckets - - - -List of buckets to ensure exist on startup. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.clientConfig - - - -Contents of the mc ` config.json `, as a nix attribute set. - -By default, ` local ` is configured to connect to the devenv minio service. -Use ` lib.mkForce null ` to use your regular mc configuration from ` $HOME/.mc ` instead. - - - -*Type:* -null or JSON value - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.clientPackage - - - -MinIO client package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.minio-client ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.consoleAddress - - - -IP address and port of the web UI (console). - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:9001" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.listenAddress - - - -IP address and port of the server. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:9000" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.region - - - -The physical location of the server. By default it is set to us-east-1, which is same as AWS S3’s and MinIO’s default region. - - - -*Type:* -string - - - -*Default:* -` "us-east-1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.minio.secretKey - - - -Specify the Secret key of 8 to 40 characters in length that clients use to access the server. - - - -*Type:* -string - - - -*Default:* -` "minioadmin" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix) - - - -## services.mongodb.enable - - - -Whether to enable MongoDB process and expose utilities. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix) - - - -## services.mongodb.package - - - -Which MongoDB package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.mongodb ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix) - - - -## services.mongodb.additionalArgs - - - -Additional arguments passed to ` mongod `. - - - -*Type:* -list of strings concatenated with “\\n” - - - -*Default:* - -``` -[ - "--noauth" -] -``` - - - -*Example:* - -``` -[ - "--port" - "27017" - "--noauth" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix) - - - -## services.mongodb.initDatabasePassword - - - -This used in conjunction with initDatabaseUsername, create a new user and set that user’s password. This user is created in the admin authentication database and given the role of root, which is a “superuser” role. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` "secret" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix) - - - -## services.mongodb.initDatabaseUsername - - - -This used in conjunction with initDatabasePassword, create a new user and set that user’s password. This user is created in the admin authentication database and given the role of root, which is a “superuser” role. - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` "mongoadmin" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix) - - - -## services.mysql.enable - - - -Whether to enable MySQL process and expose utilities. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.package - - - -Which package of MySQL to use - - - -*Type:* -package - - - -*Default:* -` pkgs.mariadb ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.ensureUsers - - - -Ensures that the specified users exist and have at least the ensured permissions. -The MySQL users will be identified using Unix socket authentication. This authenticates the Unix user with the -same name only, and that without the need for a password. -This option will never delete existing users or remove permissions, especially not when the value of this -option is changed. This means that users created and permissions assigned once through this option or -otherwise have to be removed manually. - - - -*Type:* -list of (submodule) - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - { - name = "devenv"; - ensurePermissions = { - "devenv.*" = "ALL PRIVILEGES"; - }; - } -] - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.ensureUsers.\*.ensurePermissions - - - -Permissions to ensure for the user, specified as attribute set. -The attribute names specify the database and tables to grant the permissions for, -separated by a dot. You may use wildcards here. -The attribute values specfiy the permissions to grant. -You may specify one or multiple comma-separated SQL privileges here. -For more information on how to specify the target -and on which privileges exist, see the -[GRANT syntax](https://mariadb.com/kb/en/library/grant/). -The attributes are used as ` GRANT ${attrName} ON ${attrValue} `. - - - -*Type:* -attribute set of string - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - "database.*" = "ALL PRIVILEGES"; - "*.*" = "SELECT, LOCK TABLES"; -} - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.ensureUsers.\*.name - - - -Name of the user to ensure. - - - -*Type:* -string - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.ensureUsers.\*.password - - - -Password of the user to ensure. - - - -*Type:* -null or string - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.importTimeZones - - - -Whether to import tzdata on the first startup of the mysql server - - - -*Type:* -null or boolean - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.initialDatabases - - - -List of database names and their initial schemas that should be used to create databases on the first startup -of MySQL. The schema attribute is optional: If not specified, an empty database is created. - - - -*Type:* -list of (submodule) - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - { name = "foodatabase"; schema = ./foodatabase.sql; } - { name = "bardatabase"; } -] - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.initialDatabases.\*.name - - - -The name of the database to create. - - - -*Type:* -string - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.initialDatabases.\*.schema - - - -The initial schema of the database; if null (the default), -an empty database is created. - - - -*Type:* -null or path - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.settings - - - -MySQL configuration. - - - -*Type:* -lazy attribute set of lazy attribute set of anything - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - mysqld = { - key_buffer_size = "6G"; - table_cache = 1600; - log-error = "/var/log/mysql_err.log"; - plugin-load-add = [ "server_audit" "ed25519=auth_ed25519" ]; - }; - mysqldump = { - quick = true; - max_allowed_packet = "16M"; - }; -} - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.mysql.useDefaultsExtraFile - - - -Whether to use defaults-exta-file for the mysql command instead of defaults-file. -This is useful if you want to provide a config file on the command line. -However this can problematic if you have MySQL installed globaly because its config might leak into your environment. -This option does not affect the mysqld command. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix) - - - -## services.nginx.enable - - - -Whether to enable nginx. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix) - - - -## services.nginx.package - - - -The nginx package to use. - - - -*Type:* -package - - - -*Default:* -` "pkgs.nginx" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix) - - - -## services.nginx.defaultMimeTypes - - - -Default MIME types for NGINX, as MIME types definitions from NGINX are very incomplete, -we use by default the ones bundled in the mailcap package, used by most of the other -Linux distributions. - - - -*Type:* -path - - - -*Default:* -` ${pkgs.mailcap}/etc/nginx/mime.types ` - - - -*Example:* -` ${pkgs.nginx}/conf/mime.types ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix) - - - -## services.nginx.eventsConfig - - - -The nginx events configuration. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix) - - - -## services.nginx.httpConfig - - - -The nginx configuration. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix) - - - -## services.opensearch.enable - - - -Whether to enable OpenSearch. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.package - - - -The OpenSearch package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.opensearch ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.extraCmdLineOptions - - - -Extra command line options for the OpenSearch launcher. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.extraJavaOptions - - - -Extra command line options for Java. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "-Djava.net.preferIPv4Stack=true" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.logging - - - -OpenSearch logging configuration. - - - -*Type:* -string - - - -*Default:* - -``` -'' - logger.action.name = org.opensearch.action - logger.action.level = info - appender.console.type = Console - appender.console.name = console - appender.console.layout.type = PatternLayout - appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n - rootLogger.level = info - rootLogger.appenderRef.console.ref = console -'' -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.settings - - - -OpenSearch configuration. - - - -*Type:* -YAML value - - - -*Default:* -` { } ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.settings."cluster.name" - - - -The name of the cluster. - - - -*Type:* -string - - - -*Default:* -` "opensearch" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.settings."discovery.type" - - - -The type of discovery to use. - - - -*Type:* -string - - - -*Default:* -` "single-node" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.settings."http.port" - - - -The port to listen on for HTTP traffic. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 9200 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.settings."network.host" - - - -Which port this service should listen on. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opensearch.settings."transport.port" - - - -The port to listen on for transport traffic. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 9300 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix) - - - -## services.opentelemetry-collector.enable - - - -Whether to enable opentelemetry-collector. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix) - - - -## services.opentelemetry-collector.package - - - -The OpenTelemetry Collector package to use - - - -*Type:* -package - - - -*Default:* -` pkgs.opentelemetry-collector-contrib ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix) - - - -## services.opentelemetry-collector.configFile - - - -Override the configuration file used by OpenTelemetry Collector. -By default, a configuration is generated from ` services.opentelemetry-collector.settings `. - -If overriding, enable the ` health_check ` extension to allow process-compose to check whether the Collector is ready. -Otherwise, disable the readiness probe by setting ` processes.opentelemetry-collector.process-compose.readiness_probe = {}; `. - - - -*Type:* -null or path - - - -*Default:* -` null ` - - - -*Example:* - -``` -pkgs.writeTextFile { name = "otel-config.yaml"; text = "..."; } - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix) - - - -## services.opentelemetry-collector.settings - - - -OpenTelemetry Collector configuration. -Refer to https://opentelemetry.io/docs/collector/configuration/ -for more information on how to configure the Collector. - - - -*Type:* -YAML value - - - -*Default:* - -``` -{ - extensions = { - health_check = { - endpoint = "localhost:13133"; - }; - }; - service = { - extensions = [ - "health_check" - ]; - }; -} -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix) - - - -## services.postgres.enable - - - -Whether to enable Add PostgreSQL process. -. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.package - - - -The PostgreSQL package to use. Use this to override the default with a specific version. - - - -*Type:* -package - - - -*Default:* -` pkgs.postgresql ` - - - -*Example:* - -``` -pkgs.postgresql_15 - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.createDatabase - - - -Create a database named like current user on startup. Only applies when initialDatabases is an empty list. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.extensions - - - -Additional PostgreSQL extensions to install. - -The available extensions are: - - - age - - anonymizer - - apache_datasketches - - citus - - cstore_fdw - - h3-pg - - hypopg - - jsonb_deep_sum - - lantern - - periods - - pg_auto_failover - - pg_bigm - - pg_cron - - pg_ed25519 - - pg_embedding - - pg_hint_plan - - pg_hll - - pg_ivm - - pg_libversion - - pg_net - - pg_partman - - pg_rational - - pg_relusage - - pg_repack - - pg_roaringbitmap - - pg_safeupdate - - pg_similarity - - pg_squeeze - - pg_topn - - pg_uuidv7 - - pgaudit - - pgjwt - - pgroonga - - pgrouting - - pgsodium - - pgsql-http - - pgtap - - pgvecto-rs - - pgvector - - plpgsql_check - - plr - - plv8 - - postgis - - promscale_extension - - repmgr - - rum - - smlar - - tds_fdw - - temporal_tables - - timescaledb - - timescaledb-apache - - timescaledb_toolkit - - tsearch_extras - - tsja - - wal2json - - - -*Type:* -null or (function that evaluates to a(n) list of package) - - - -*Default:* -` null ` - - - -*Example:* - -``` -extensions: [ - extensions.pg_cron - extensions.postgis - extensions.timescaledb -]; - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.hbaConf - - - -The contents of a custom pg_hba.conf file to copy into the postgres installation. -This allows for custom connection rules that you want to establish on the server. - - - -*Type:* -null or string - - - -*Default:* -` null ` - - - -*Example:* - -``` -builtins.readFile ./my-custom/directory/to/pg_hba.conf - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.initdbArgs - - - -Additional arguments passed to ` initdb ` during data dir -initialisation. - - - -*Type:* -list of strings concatenated with “\\n” - - - -*Default:* - -``` -[ - "--locale=C" - "--encoding=UTF8" -] -``` - - - -*Example:* - -``` -[ - "--data-checksums" - "--allow-group-access" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.initialDatabases - - - -List of database names and their initial schemas that should be used to create databases on the first startup -of Postgres. The schema attribute is optional: If not specified, an empty database is created. - - - -*Type:* -list of (submodule) - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - { - name = "foodatabase"; - schema = ./foodatabase.sql; - } - { name = "bardatabase"; } -] - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.initialDatabases.\*.name - - - -The name of the database to create. - - - -*Type:* -string - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.initialDatabases.\*.pass - - - -Password of owner of the database (only takes effect if ` user ` is not ` null `). - - - -*Type:* -null or string - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.initialDatabases.\*.schema - - - -The initial schema of the database; if null (the default), -an empty database is created. - - - -*Type:* -null or path - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.initialDatabases.\*.user - - - -Username of owner of the database (if null, the default $USER is used). - - - -*Type:* -null or string - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.initialScript - - - -Initial SQL commands to run during database initialization. This can be multiple -SQL expressions separated by a semi-colon. - - - -*Type:* -null or string - - - -*Default:* -` null ` - - - -*Example:* - -``` -CREATE ROLE postgres SUPERUSER; -CREATE ROLE bar; - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.listen_addresses - - - -Listen address - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.port - - - -The TCP port to accept connections. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 5432 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.postgres.settings - - - -PostgreSQL configuration. Refer to -[https://www.postgresql.org/docs/11/config-setting.html\#CONFIG-SETTING-CONFIGURATION-FILE](https://www.postgresql.org/docs/11/config-setting.html\#CONFIG-SETTING-CONFIGURATION-FILE) -for an overview of ` postgresql.conf `. - -String values will automatically be enclosed in single quotes. Single quotes will be -escaped with two single quotes as described by the upstream documentation linked above. - - - -*Type:* -attribute set of (boolean or floating point number or signed integer or string) - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - log_connections = true; - log_statement = "all"; - logging_collector = true - log_disconnections = true - log_destination = lib.mkForce "syslog"; -} - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix) - - - -## services.rabbitmq.enable - - - -Whether to enable the RabbitMQ server, an Advanced Message -Queuing Protocol (AMQP) broker. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.package - - - -Which rabbitmq package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.rabbitmq-server ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.configItems - - - -Configuration options in RabbitMQ’s new config file format, -which is a simple key-value format that can not express nested -data structures. This is known as the ` rabbitmq.conf ` file, -although outside NixOS that filename may have Erlang syntax, particularly -prior to RabbitMQ 3.7.0. -If you do need to express nested data structures, you can use -` config ` option. Configuration from ` config ` -will be merged into these options by RabbitMQ at runtime to -form the final configuration. -See [https://www.rabbitmq.com/configure.html\#config-items](https://www.rabbitmq.com/configure.html\#config-items) -For the distinct formats, see [https://www.rabbitmq.com/configure.html\#config-file-formats](https://www.rabbitmq.com/configure.html\#config-file-formats) - - - -*Type:* -attribute set of string - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - "auth_backends.1.authn" = "rabbit_auth_backend_ldap"; - "auth_backends.1.authz" = "rabbit_auth_backend_internal"; -} - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.cookie - - - -Erlang cookie is a string of arbitrary length which must -be the same for several nodes to be allowed to communicate. -Leave empty to generate automatically. - - - -*Type:* -string - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.listenAddress - - - -IP address on which RabbitMQ will listen for AMQP -connections. Set to the empty string to listen on all -interfaces. Note that RabbitMQ creates a user named -` guest ` with password -` guest ` by default, so you should delete -this user if you intend to allow external access. -Together with ‘port’ setting it’s mostly an alias for -configItems.“listeners.tcp.1” and it’s left for backwards -compatibility with previous version of this module. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - - - -*Example:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.managementPlugin.enable - - - -Whether to enable the management plugin. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.managementPlugin.port - - - -On which port to run the management plugin - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 15672 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.nodeName - - - -The name of the RabbitMQ node. This is used to identify -the node in a cluster. If you are running multiple -RabbitMQ nodes on the same machine, you must give each -node a unique name. The name must be of the form -` name@host `, where ` name ` is an arbitrary name and -` host ` is the domain name of the host. - - - -*Type:* -string - - - -*Default:* -` "rabbit@localhost" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.pluginDirs - - - -The list of directories containing external plugins - - - -*Type:* -list of path - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.plugins - - - -The names of plugins to enable - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.rabbitmq.port - - - -Port on which RabbitMQ will listen for AMQP connections. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 5672 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix) - - - -## services.redis.enable - - - -Whether to enable Redis process and expose utilities. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix) - - - -## services.redis.package - - - -Which package of Redis to use - - - -*Type:* -package - - - -*Default:* -` pkgs.redis ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix) - - - -## services.redis.bind - - - -The IP interface to bind to. -` null ` means “all interfaces”. - - - -*Type:* -null or string - - - -*Default:* -` "127.0.0.1" ` - - - -*Example:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix) - - - -## services.redis.extraConfig - - - -Additional text to be appended to ` redis.conf `. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "locale-collate C" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix) - - - -## services.redis.port - - - -The TCP port to accept connections. -If port 0 is specified Redis, will not listen on a TCP socket and a unix socket file will be found at $REDIS_UNIX_SOCKET. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 6379 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix) - - - -## services.sqld.enable - - - -Whether to enable sqld. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix) - - - -## services.sqld.extraArgs - - - -Add other sqld flags. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix) - - - -## services.sqld.port - - - -Port number to listen on - - - -*Type:* -signed integer - - - -*Default:* -` 8080 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix) - - - -## services.temporal.enable - - - -Whether to enable Temporal process. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.package - - - -Which package of Temporal to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.temporal-cli ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.ip - - - -IPv4 address to bind the frontend service to. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.namespaces - - - -Specify namespaces that should be pre-created (namespace “default” is always created). - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "my-namespace" - "my-other-namespace" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.port - - - -Port for the frontend gRPC service. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 7233 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.state - - - -State configuration. - - - -*Type:* -submodule - - - -*Default:* -` { } ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.state.ephemeral - - - -When enabled, the Temporal state gets lost when the process exists. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.state.sqlite-pragma - - - -Sqlite pragma statements - - - -*Type:* -attribute set of string - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - journal_mode = "wal"; - synchronous = "2"; -} -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.ui - - - -UI configuration. - - - -*Type:* -submodule - - - -*Default:* -` { } ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.ui.enable - - - -Enable the Web UI. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.ui.ip - - - -IPv4 address to bind the Web UI to. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.temporal.ui.port - - - -Port for the Web UI. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -[` services.temporal.port `](\#servicestemporalport) + 1000 - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix) - - - -## services.trafficserver.enable - - - -Whether to enable Apache Traffic Server. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.package - - - -Apache Traffic Server package - - - -*Type:* -package - - - -*Default:* -` pkgs.trafficserver ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.cache - - - -Caching rules that overrule the origin’s caching policy. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/cache.config.en.html) -for more details. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* -` "dest_domain=example.com suffix=js action=never-cache" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.hosting - - - -Partition the cache according to origin server or domain - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/hosting.config.en.html) -for more details. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* -` "domain=example.com volume=1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.ipAllow - - - -Control client access to Traffic Server and Traffic Server connections -to upstream servers. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/ip_allow.yaml.en.html) -for more details. - - - -*Type:* -null or YAML value - - - -*Default:* -upstream defaults - - - -*Example:* - -``` -{ - ip_allow = [{ - apply = "in"; - ip_addrs = "127.0.0.1"; - action = "allow"; - methods = "ALL"; - }]; -} - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.logging - - - -Configure logs. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/logging.yaml.en.html) -for more details. - - - -*Type:* -null or YAML value - - - -*Default:* -upstream defaults - - - -*Example:* -` { } ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.parent - - - -Identify the parent proxies used in an cache hierarchy. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html) -for more details. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - dest_domain=. method=get parent="p1.example:8080; p2.example:8080" round_robin=true -'' -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.plugins - - - -Controls run-time loadable plugins available to Traffic Server, as -well as their configuration. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/plugin.config.en.html) -for more details. - - - -*Type:* -list of (submodule) - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.plugins.\*.arg - - - -arguments to pass to the plugin - - - -*Type:* -string - - - -*Default:* -` "" ` - - - -*Example:* -` "--header=ATS-My-Debug" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.plugins.\*.path - - - -Path to plugin. The path can either be absolute, or relative to -the plugin directory. - - - -*Type:* -string - - - -*Example:* -` "xdebug.so" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.records - - - -List of configurable variables used by Traffic Server. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html) -for more details. - -When defining the values for the option ` x.y `, a nested attribute should -be used. Using a flat attribute set with the attribute name ` x.y ` will -result in an error. - -If options for both ` x.y ` and ` x.y.z ` needs to be set, you can set -` x.y._ ` as ` x.y `. This only applies to Traffic Server versions prior to -10. Traffic Server 10 and onwards uses YAML configuration, which doesn’t -have this kind of problem. - - - -*Type:* -Traffic Server records value - - - -*Default:* -` { } ` - - - -*Example:* - -``` -{ - proxy = { - config = { - proxy_name = "my_server"; - }; - }; -} -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.remap - - - -URL remapping rules used by Traffic Server. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/remap.config.en.html) -for more details. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* -` "map http://from.example http://origin.example" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.runroot - - - -File layout used by Traffic Server - - - -*Type:* -unspecified value *(read only)* - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.sni - - - -Configure aspects of TLS connection handling for both inbound and -outbound connections. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/sni.yaml.en.html) -for more details. - - - -*Type:* -null or YAML value - - - -*Default:* -` null ` - - - -*Example:* - -``` -{ - sni = [{ - fqdn = "no-http2.example.com"; - https = "off"; - }]; -} - -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.splitDns - - - -Specify the DNS server that Traffic Server should use under specific -conditions. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/splitdns.config.en.html) -for more details. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - dest_domain=internal.corp.example named="255.255.255.255:212 255.255.255.254" def_domain=corp.example search_list="corp.example corp1.example" - dest_domain=!internal.corp.example named=255.255.255.253 -'' -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.sslMulticert - - - -Configure SSL server certificates to terminate the SSL sessions. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/ssl_multicert.config.en.html) -for more details. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* -` "dest_ip=* ssl_cert_name=default.pem" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.storage - - - -List all the storage that make up the Traffic Server cache. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/storage.config.en.html) -for more details. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "${config.services.traffic-server.runroot.cachedir} 256M" ` - - - -*Example:* -` "/dev/disk/by-id/XXXXX volume=1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.strategies - - - -Specify the next hop proxies used in an cache hierarchy and the -algorithms used to select the next proxy. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/strategies.yaml.en.html) -for more details. - - - -*Type:* -null or YAML value - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.trafficserver.volume - - - -Manage cache space more efficiently and restrict disk usage by -creating cache volumes of different sizes. - -Consult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/volume.config.en.html) -for more details. - - - -*Type:* -null or YAML value - - - -*Default:* -` "" ` - - - -*Example:* -` "volume=1 scheme=http size=20%" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver](https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver) - - - -## services.typesense.enable - - - -Whether to enable typesense process. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix) - - - -## services.typesense.package - - - -Which package of typesense to use - - - -*Type:* -package - - - -*Default:* -` pkgs.typesense ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix) - - - -## services.typesense.additionalArgs - - - -Additional arguments passed to ` typesense `. - - - -*Type:* -list of strings concatenated with “\\n” - - - -*Default:* -` [ ] ` - - - -*Example:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix) - - - -## services.typesense.apiKey - - - -API Key. - - - -*Type:* -string - - - -*Default:* -` "example" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix) - - - -## services.typesense.host - - - -The HTTP host to accept connections. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix) - - - -## services.typesense.port - - - -The HTTP port to accept connections. - - - -*Type:* -16 bit unsigned integer; between 0 and 65535 (both inclusive) - - - -*Default:* -` 8108 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix) - - - -## services.typesense.searchOnlyKey - - - -Search Only Key. - - - -*Type:* -null or string - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix) - - - -## services.varnish.enable - - - -Whether to enable Varnish process and expose utilities. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix) - - - -## services.varnish.package - - - -Which Varnish package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.varnish ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix) - - - -## services.varnish.extraModules - - - -Varnish modules (except ‘std’). - - - -*Type:* -list of package - - - -*Default:* -` [ ] ` - - - -*Example:* -` [ pkgs.varnish73Packages.modules ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix) - - - -## services.varnish.listen - - - -Which address to listen on. - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:6081" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix) - - - -## services.varnish.memorySize - - - -How much memory to allocate to Varnish. - - - -*Type:* -string - - - -*Default:* -` "64M" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix) - - - -## services.varnish.vcl - - - -Varnish VCL configuration. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* - -``` -'' - vcl 4.0; - - backend default { - .host = "127.0.0.1"; - .port = "80"; - } -'' -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix) - - - -## services.vault.enable - - - -Whether to enable vault process. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix) - - - -## services.vault.package - - - -Which package of Vault to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.vault-bin ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix) - - - -## services.vault.address - - - -Specifies the address to bind to for listening - - - -*Type:* -string - - - -*Default:* -` "127.0.0.1:8200" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix) - - - -## services.vault.disableClustering - - - -Specifies whether clustering features such as request forwarding are enabled - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix) - - - -## services.vault.disableMlock - - - -Disables the server from executing the mlock syscall - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix) - - - -## services.vault.ui - - - -Enables the built-in web UI - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix) - - - -## services.wiremock.enable - - - -Whether to enable WireMock. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix) - - - -## services.wiremock.package - - - -Which package of WireMock to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.wiremock ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix) - - - -## services.wiremock.disableBanner - - - -Whether to disable print banner logo. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix) - - - -## services.wiremock.mappings - - - -The mappings to mock. -See the JSON examples on [https://wiremock.org/docs/stubbing/](https://wiremock.org/docs/stubbing/) for more information. - - - -*Type:* -JSON value - - - -*Default:* -` [ ] ` - - - -*Example:* - -``` -[ - { - request = { - method = "GET"; - url = "/body"; - }; - response = { - body = "Literal text to put in the body"; - headers = { - Content-Type = "text/plain"; - }; - status = 200; - }; - } - { - request = { - method = "GET"; - url = "/json"; - }; - response = { - jsonBody = { - someField = "someValue"; - }; - status = 200; - }; - } -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix) - - - -## services.wiremock.port - - - -The port number for the HTTP server to listen on. - - - -*Type:* -signed integer - - - -*Default:* -` 8080 ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix) - - - -## services.wiremock.verbose - - - -Whether to log verbosely to stdout. - - - -*Type:* -boolean - - - -*Default:* -` false ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix) - - - -## starship.enable - - - -Whether to enable the Starship.rs command prompt. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix) - - - -## starship.package - - - -The Starship package to use. - - - -*Type:* -package - - - -*Default:* -` pkgs.starship ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix) - - - -## starship.config.enable - - - -Whether to enable Starship config override. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix) - - - -## starship.config.path - - - -The Starship configuration file to use. - - - -*Type:* -path - - - -*Default:* -` ${config.env.DEVENV_ROOT}/starship.toml ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix) - - - -## stdenv - - - -The stdenv to use for the developer environment. - - - -*Type:* -package - - - -*Default:* -` ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix](https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix) - - - -## tasks - - - -A set of tasks. - - - -*Type:* -attribute set of (submodule) - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.package - - - -Package to install for this task. - - - -*Type:* -package - - - -*Default:* -` ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.after - - - -List of tasks to run after this task. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.before - - - -List of tasks to run before this task. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.binary - - - -Override the binary name if it doesn’t match package name - - - -*Type:* -string - - - -*Default:* -` "bash" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.description - - - -Description of the task. - - - -*Type:* -string - - - -*Default:* -` "" ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.exec - - - -Command to execute the task. - - - -*Type:* -null or string - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.exports - - - -List of environment variables to export. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.input - - - -Input values for the task, encoded as JSON. - - - -*Type:* -attribute set of anything - - - -*Default:* -` { } ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## tasks.\.status - - - -Check if the command should be ran - - - -*Type:* -null or string - - - -*Default:* -` null ` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix](https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix) - - - -## unsetEnvVars - - - -A list of removed environment variables to make the shell/direnv more lean. - - - -*Type:* -list of string - - - -*Default:* - -``` -[ - "HOST_PATH" - "NIX_BUILD_CORES" - "__structuredAttrs" - "buildInputs" - "buildPhase" - "builder" - "depsBuildBuild" - "depsBuildBuildPropagated" - "depsBuildTarget" - "depsBuildTargetPropagated" - "depsHostHost" - "depsHostHostPropagated" - "depsTargetTarget" - "depsTargetTargetPropagated" - "dontAddDisableDepTrack" - "doCheck" - "doInstallCheck" - "nativeBuildInputs" - "out" - "outputs" - "patches" - "phases" - "preferLocalBuild" - "propagatedBuildInputs" - "propagatedNativeBuildInputs" - "shell" - "shellHook" - "stdenv" - "strictDeps" -] -``` - -*Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix](https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix) - - [comment]: # (DO NOT MODIFY. This file was generated by devenv-generate-doc-options.) # devenv.nix