From b161b892a9152c67349ca68911b6d1e93f91c417 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 20 Mar 2024 12:42:59 +0000 Subject: [PATCH] Auto generate docs/reference/options.md --- docs/reference/options.md | 2699 +++++++++++++++++++++++++++++++------ 1 file changed, 2271 insertions(+), 428 deletions(-) diff --git a/docs/reference/options.md b/docs/reference/options.md index 2609a089f..0984e407f 100644 --- a/docs/reference/options.md +++ b/docs/reference/options.md @@ -2,7 +2,9 @@ ## packages -A list of packages to expose inside the developer environment. Search available packages using ``devenv search NAME``. + + +A list of packages to expose inside the developer environment. Search available packages using ` devenv search NAME `. @@ -21,6 +23,8 @@ list of package ## aws-vault.enable + + Whether to enable aws-vault integration. @@ -45,6 +49,8 @@ boolean ## aws-vault.package + + The aws-vault package to use. @@ -66,6 +72,8 @@ package Attribute set of packages including awscli2 + + *Type:* submodule @@ -81,7 +89,9 @@ submodule ## aws-vault.awscliWrapper.enable -Whether to enable Wraps awscli2 binary as `aws-vault exec -- aws `. + + +Whether to enable Wraps awscli2 binary as ` aws-vault exec -- aws `. . @@ -106,6 +116,8 @@ boolean ## aws-vault.awscliWrapper.package + + The awscli2 package to use. @@ -125,6 +137,8 @@ package ## aws-vault.opentofuWrapper + + Attribute set of packages including opentofu @@ -144,7 +158,9 @@ submodule ## aws-vault.opentofuWrapper.enable -Whether to enable Wraps opentofu binary as `aws-vault exec -- opentofu `. + + +Whether to enable Wraps opentofu binary as ` aws-vault exec -- opentofu `. . @@ -169,6 +185,8 @@ boolean ## aws-vault.opentofuWrapper.package + + The opentofu package to use. @@ -204,6 +222,8 @@ string ## aws-vault.terraformWrapper + + Attribute set of packages including terraform @@ -223,7 +243,9 @@ submodule ## aws-vault.terraformWrapper.enable -Whether to enable Wraps terraform binary as `aws-vault exec -- terraform `. + + +Whether to enable Wraps terraform binary as ` aws-vault exec -- terraform `. . @@ -248,6 +270,8 @@ boolean ## aws-vault.terraformWrapper.package + + The terraform package to use. @@ -265,8 +289,68 @@ package +## 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.pull + + + +What caches to pull from. + + + +*Type:* +list of string + +*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. @@ -297,6 +381,8 @@ list of string ## container.isBuilding + + Set to true when the environment is building a container. @@ -316,7 +402,9 @@ boolean ## containers -Container specifications that can be built, copied and ran using `devenv container`. + + +Container specifications that can be built, copied and ran using ` devenv container `. @@ -335,6 +423,8 @@ attribute set of (submodule) ## containers.\.copyToRoot + + Add a path to the container. Defaults to the whole git repo. @@ -354,10 +444,11 @@ null or path or list of path ## containers.\.defaultCopyArgs -Default arguments to pass to `skopeo copy`. -You can override them by passing arguments to the script. +Default arguments to pass to ` skopeo copy `. +You can override them by passing arguments to the script. + *Type:* @@ -375,6 +466,8 @@ list of string ## containers.\.entrypoint + + Entrypoint of the container. @@ -394,6 +487,8 @@ list of anything ## containers.\.isBuilding + + Set to true when the environment is building this container. @@ -413,29 +508,16 @@ boolean ## containers.\.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) +Maximum number of container layers created. -## containers.\.maxLayers +*Type:* +null or signed integer -The maximum number of layers created when the container is created. -*Type:* -int *Default:* ` 1 ` @@ -447,6 +529,8 @@ int ## containers.\.name + + Name of the container. @@ -466,6 +550,8 @@ null or string ## containers.\.registry + + Registry to push the container to. @@ -485,6 +571,8 @@ null or string ## containers.\.startupCommand + + Command to run in the container. @@ -504,6 +592,8 @@ null or string or package ## containers.\.version + + Version/tag of the container. @@ -523,6 +613,8 @@ null or string ## delta.enable + + Integrate delta into git: https://dandavison.github.io/delta/. @@ -542,6 +634,8 @@ boolean ## devcontainer.enable + + Whether to enable generation .devcontainer.json for devenv integration. @@ -667,7 +761,7 @@ anything *Default:* -` "devenv ci" ` +` "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) @@ -676,6 +770,8 @@ anything ## devenv.debug + + Whether to enable debug mode of devenv enterShell script. @@ -700,9 +796,10 @@ boolean ## devenv.flakesIntegration -Tells if devenv is being imported by a flake.nix file +Tells if devenv is being imported by a flake.nix file + *Type:* @@ -720,9 +817,10 @@ boolean ## devenv.latestVersion -The latest version of devenv. +The latest version of devenv. + *Type:* @@ -731,7 +829,7 @@ string *Default:* -` "0.6.3" ` +` "1.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) @@ -740,9 +838,10 @@ string ## devenv.warnOnNewVersion -Whether to warn when a new version of devenv is available. +Whether to warn when a new version of devenv is available. + *Type:* @@ -760,6 +859,8 @@ boolean ## difftastic.enable + + Integrate difftastic into git: https://difftastic.wilfred.me.uk/. @@ -779,7 +880,9 @@ boolean ## dotenv.enable -Whether to enable .env integration, doesn't support comments or multiline values.. + + +Whether to enable .env integration, doesn’t support comments or multiline values… @@ -803,6 +906,8 @@ boolean ## dotenv.disableHint + + Disable the hint that are printed when the dotenv module is not enabled, but .env is present. @@ -822,6 +927,8 @@ boolean ## dotenv.filename + + The name of the dotenv file to load, or a list of dotenv files to load in order of precedence. @@ -841,6 +948,8 @@ string or list of string ## enterShell + + Bash code to execute when entering the shell. @@ -858,8 +967,26 @@ strings concatenated with “\\n” +## 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. @@ -879,6 +1006,8 @@ lazy attribute set of anything ## hosts + + List of hosts entries. @@ -912,6 +1041,8 @@ attribute set of (string or list of string) ## hostsProfileName + + Profile name to use. @@ -931,6 +1062,8 @@ string ## infoSections + + Information about the environment @@ -950,6 +1083,8 @@ attribute set of list of string ## languages.ansible.enable + + Whether to enable tools for Ansible development. @@ -974,6 +1109,8 @@ boolean ## languages.ansible.package + + The Ansible package to use. @@ -993,6 +1130,8 @@ package ## languages.c.enable + + Whether to enable tools for C development. @@ -1017,6 +1156,8 @@ boolean ## languages.clojure.enable + + Whether to enable tools for Clojure development. @@ -1041,6 +1182,8 @@ boolean ## languages.cplusplus.enable + + Whether to enable tools for C++ development. @@ -1065,7 +1208,9 @@ boolean ## languages.crystal.enable -Whether to enable Enable tools for Crystal development.. + + +Whether to enable Enable tools for Crystal development… @@ -1089,6 +1234,8 @@ boolean ## languages.cue.enable + + Whether to enable tools for Cue development. @@ -1113,6 +1260,8 @@ boolean ## languages.cue.package + + The CUE package to use. @@ -1132,6 +1281,8 @@ package ## languages.dart.enable + + Whether to enable tools for Dart development. @@ -1156,6 +1307,8 @@ boolean ## languages.dart.package + + The Dart package to use. @@ -1175,6 +1328,8 @@ package ## languages.deno.enable + + Whether to enable tools for Deno development. @@ -1199,6 +1354,8 @@ boolean ## languages.dotnet.enable + + Whether to enable tools for .NET development. @@ -1223,6 +1380,8 @@ boolean ## languages.dotnet.package + + The .NET SDK package to use. @@ -1242,6 +1401,8 @@ package ## languages.elixir.enable + + Whether to enable tools for Elixir development. @@ -1266,6 +1427,8 @@ boolean ## languages.elixir.package + + Which package of Elixir to use. @@ -1285,6 +1448,8 @@ package ## languages.elm.enable + + Whether to enable tools for Elm development. @@ -1309,6 +1474,8 @@ boolean ## languages.erlang.enable + + Whether to enable tools for Erlang development. @@ -1333,6 +1500,8 @@ boolean ## languages.erlang.package + + Which package of Erlang to use. @@ -1352,6 +1521,8 @@ package ## languages.gawk.enable + + Whether to enable tools for GNU Awk development. @@ -1376,6 +1547,8 @@ boolean ## languages.gleam.enable + + Whether to enable tools for Gleam development. @@ -1400,6 +1573,8 @@ boolean ## languages.gleam.package + + The Gleam package to use. @@ -1419,6 +1594,8 @@ package ## languages.go.enable + + Whether to enable tools for Go development. @@ -1443,6 +1620,8 @@ boolean ## languages.go.package + + The Go package to use. @@ -1462,6 +1641,8 @@ package ## languages.haskell.enable + + Whether to enable tools for Haskell development. @@ -1486,9 +1667,10 @@ boolean ## languages.haskell.package -Haskell compiler to use. +Haskell compiler to use. + *Type:* @@ -1506,9 +1688,10 @@ package ## languages.haskell.languageServer -Haskell language server to use. +Haskell language server to use. + *Type:* @@ -1526,9 +1709,10 @@ null or package ## languages.haskell.stack -Haskell stack to use. +Haskell stack to use. + *Type:* @@ -1546,6 +1730,8 @@ null or package ## languages.idris.enable + + Whether to enable tools for Idris development. @@ -1570,9 +1756,10 @@ boolean ## languages.idris.package -The Idris package to use. +The Idris package to use. + *Type:* @@ -1595,6 +1782,8 @@ package ## languages.java.enable + + Whether to enable tools for Java development. @@ -1619,6 +1808,8 @@ boolean ## languages.java.gradle.enable + + Whether to enable gradle. @@ -1643,15 +1834,21 @@ boolean ## languages.java.gradle.package -The Gradle package to use. -The Gradle package by default inherits the JDK from `languages.java.jdk.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 { jdk = 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) @@ -1659,10 +1856,11 @@ package ## languages.java.jdk.package -The JDK package to use. -This will also become available as `JAVA_HOME`. +The JDK package to use. +This will also become available as ` JAVA_HOME `. + *Type:* @@ -1685,6 +1883,8 @@ package ## languages.java.maven.enable + + Whether to enable maven. @@ -1709,15 +1909,21 @@ boolean ## languages.java.maven.package -The Maven package to use. -The Maven package by default inherits the JDK from `languages.java.jdk.package`. +The Maven package to use. +The Maven package by default inherits the JDK from ` languages.java.jdk.package `. + *Type:* package + + +*Default:* +` "pkgs.maven.override { jdk = cfg.jdk.package; }" ` + *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix) @@ -1725,6 +1931,8 @@ package ## languages.javascript.enable + + Whether to enable tools for JavaScript development. @@ -1749,6 +1957,8 @@ boolean ## languages.javascript.package + + The Node.js package to use. @@ -1768,6 +1978,8 @@ package ## languages.javascript.bun.enable + + Whether to enable install bun. @@ -1792,6 +2004,8 @@ boolean ## languages.javascript.bun.package + + The bun package to use. @@ -1811,6 +2025,8 @@ package ## languages.javascript.bun.install.enable + + Whether to enable bun install during devenv initialisation. @@ -1835,6 +2051,8 @@ boolean ## languages.javascript.corepack.enable + + Whether to enable wrappers for npm, pnpm and Yarn via Node.js Corepack. @@ -1859,10 +2077,11 @@ boolean ## 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. +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:* @@ -1885,6 +2104,8 @@ string ## languages.javascript.npm.enable + + Whether to enable install npm. @@ -1909,6 +2130,8 @@ boolean ## languages.javascript.npm.package + + The Node.js package to use. @@ -1928,6 +2151,8 @@ package ## languages.javascript.npm.install.enable + + Whether to enable npm install during devenv initialisation. @@ -1952,6 +2177,8 @@ boolean ## languages.javascript.pnpm.enable + + Whether to enable install pnpm. @@ -1976,6 +2203,8 @@ boolean ## languages.javascript.pnpm.package + + The pnpm package to use. @@ -1995,6 +2224,8 @@ package ## languages.javascript.pnpm.install.enable + + Whether to enable pnpm install during devenv initialisation. @@ -2019,6 +2250,8 @@ boolean ## languages.javascript.yarn.enable + + Whether to enable install yarn. @@ -2043,6 +2276,8 @@ boolean ## languages.javascript.yarn.package + + The yarn package to use. @@ -2062,6 +2297,8 @@ package ## languages.javascript.yarn.install.enable + + Whether to enable yarn install during devenv initialisation. @@ -2086,6 +2323,8 @@ boolean ## languages.jsonnet.enable + + Whether to enable tools for jsonnet development. @@ -2134,6 +2373,8 @@ boolean ## languages.julia.package + + The Julia package to use. @@ -2153,6 +2394,8 @@ package ## languages.kotlin.enable + + Whether to enable tools for Kotlin development. @@ -2177,6 +2420,8 @@ boolean ## languages.lua.enable + + Whether to enable tools for Lua development. @@ -2201,8 +2446,12 @@ boolean ## languages.lua.package + + The Lua package to use. + + *Type:* package @@ -2218,6 +2467,8 @@ package ## languages.nim.enable + + Whether to enable tools for Nim development. @@ -2242,6 +2493,8 @@ boolean ## languages.nim.package + + The Nim package to use. @@ -2261,6 +2514,8 @@ package ## languages.nix.enable + + Whether to enable tools for Nix development. @@ -2285,6 +2540,8 @@ boolean ## languages.nix.lsp.package + + The LSP package to use @@ -2304,6 +2561,8 @@ package ## languages.ocaml.enable + + Whether to enable tools for OCaml development. @@ -2328,6 +2587,8 @@ boolean ## languages.ocaml.packages + + The package set of OCaml to use @@ -2347,6 +2608,8 @@ attribute set ## languages.opentofu.enable + + Whether to enable tools for OpenTofu development. @@ -2371,6 +2634,8 @@ boolean ## languages.opentofu.package + + The OpenTofu package to use. @@ -2390,6 +2655,8 @@ package ## languages.pascal.enable + + Whether to enable tools for Pascal development. @@ -2414,6 +2681,8 @@ boolean ## languages.pascal.lazarus.enable + + Whether to enable lazarus graphical IDE for the FreePascal language. @@ -2438,6 +2707,8 @@ boolean ## languages.perl.enable + + Whether to enable tools for Perl development. @@ -2462,6 +2733,8 @@ boolean ## languages.perl.packages + + Perl packages to include @@ -2491,6 +2764,8 @@ list of string ## languages.php.enable + + Whether to enable tools for PHP development. @@ -2515,11 +2790,12 @@ boolean ## 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'` +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:* @@ -2551,6 +2827,8 @@ pkgs.php.buildEnv { ## languages.php.packages + + Attribute set of packages including composer @@ -2570,6 +2848,8 @@ submodule ## languages.php.packages.composer + + composer package @@ -2589,9 +2869,10 @@ null or package ## languages.php.disableExtensions -PHP extensions to disable. +PHP extensions to disable. + *Type:* @@ -2609,9 +2890,10 @@ list of string ## languages.php.extensions -PHP extensions to enable. +PHP extensions to enable. + *Type:* @@ -2629,14 +2911,15 @@ list of string ## 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 +` error_log ` or ` daemonize ` here, since they are generated by NixOS. - *Type:* null or strings concatenated with “\\n” @@ -2652,9 +2935,10 @@ null or strings concatenated with “\\n” ## languages.php.fpm.phpOptions -Options appended to the PHP configuration file `php.ini`. +Options appended to the PHP configuration file ` php.ini `. + *Type:* @@ -2682,12 +2966,13 @@ strings concatenated with “\\n” ## languages.php.fpm.pools + + PHP-FPM pools. If no pools are defined, the PHP-FPM service is disabled. - *Type:* attribute set of (submodule) @@ -2725,13 +3010,14 @@ attribute set of (submodule) ## languages.php.fpm.pools.\.extraConfig + + Extra lines that go into the pool configuration. -See the documentation on `php-fpm.conf` for +See the documentation on ` php-fpm.conf ` for details on configuration directives. - *Type:* null or strings concatenated with “\\n” @@ -2747,9 +3033,10 @@ null or strings concatenated with “\\n” ## languages.php.fpm.pools.\.listen -The address on which to accept FastCGI requests. +The address on which to accept FastCGI requests. + *Type:* @@ -2772,9 +3059,10 @@ string ## languages.php.fpm.pools.\.phpEnv -Environment variables used for this PHP-FPM pool. +Environment variables used for this PHP-FPM pool. + *Type:* @@ -2806,9 +3094,10 @@ attribute set of string ## languages.php.fpm.pools.\.phpOptions -Options appended to the PHP configuration file `php.ini` used for this PHP-FPM pool. +Options appended to the PHP configuration file ` php.ini ` used for this PHP-FPM pool. + *Type:* @@ -2821,9 +3110,10 @@ strings concatenated with “\\n” ## languages.php.fpm.pools.\.phpPackage -The PHP package to use for running this PHP-FPM pool. +The PHP package to use for running this PHP-FPM pool. + *Type:* @@ -2841,13 +3131,14 @@ package ## languages.php.fpm.pools.\.settings -PHP-FPM pool directives. Refer to the "List of pool directives" section of - -the manual for details. Note that settings names must be -enclosed in quotes (e.g. `"pm.max_children"` instead of -`pm.max_children`). +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:* @@ -2881,13 +3172,14 @@ attribute set of (string or signed integer or boolean) ## 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)* @@ -2903,21 +3195,22 @@ string *(read only)* ## languages.php.fpm.settings -PHP-FPM global directives. -Refer to the "List of global php-fpm.conf directives" section of - -for details. + +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`). +quotes (e.g. ` "pm.max_children" ` instead of ` pm.max_children `). -You need not specify the options `error_log` or `daemonize` here, since +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) @@ -2938,9 +3231,10 @@ attribute set of (string or signed integer or boolean) ## languages.php.ini -PHP.ini directives. Refer to the "List of php.ini directives" of PHP's +PHP.ini directives. Refer to the “List of php.ini directives” of PHP’s + *Type:* @@ -2958,6 +3252,8 @@ null or strings concatenated with “\\n” ## languages.php.version + + The PHP version to use. @@ -2977,6 +3273,8 @@ string ## languages.purescript.enable + + Whether to enable tools for PureScript development. @@ -3001,6 +3299,8 @@ boolean ## languages.purescript.package + + The PureScript package to use. @@ -3020,6 +3320,8 @@ package ## languages.python.enable + + Whether to enable tools for Python development. @@ -3044,6 +3346,8 @@ boolean ## languages.python.package + + The Python package to use. @@ -3061,8 +3365,63 @@ package +## languages.python.libraries + + + +Additional libraries to make available to the Python interpreter. + +This is useful when you want to use Python wheels that depend on native libraries. + + + +*Type:* +list of path + + + +*Default:* + +``` +[ + "/home/runner/work/devenv/devenv/.devenv/profile" +] +``` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/languages/python.nix](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. @@ -3087,6 +3446,8 @@ boolean ## languages.python.poetry.package + + The Poetry package to use. @@ -3106,6 +3467,8 @@ package ## languages.python.poetry.activate.enable + + Whether to enable activate the poetry virtual environment automatically. @@ -3130,6 +3493,8 @@ boolean ## languages.python.poetry.install.enable + + Whether to enable poetry install during devenv initialisation. @@ -3154,7 +3519,9 @@ boolean ## languages.python.poetry.install.allExtras -Whether to install all extras. See `--all-extras`. + + +Whether to install all extras. See ` --all-extras `. @@ -3173,7 +3540,9 @@ boolean ## languages.python.poetry.install.extras -Which extras to install. See `--extras`. + + +Which extras to install. See ` --extras `. @@ -3192,7 +3561,9 @@ list of string ## languages.python.poetry.install.groups -Which dependency-groups to install. See `--with`. + + +Which dependency-groups to install. See ` --with `. @@ -3211,7 +3582,9 @@ list of string ## languages.python.poetry.install.installRootPackage -Whether the root package (your project) should be installed. See `--no-root` + + +Whether the root package (your project) should be installed. See ` --no-root ` @@ -3230,7 +3603,9 @@ boolean ## languages.python.poetry.install.quiet -Whether `poetry install` should avoid outputting messages during devenv initialisation. + + +Whether ` poetry install ` should avoid outputting messages during devenv initialisation. @@ -3249,6 +3624,8 @@ boolean ## languages.python.venv.enable + + Whether to enable Python virtual environment. @@ -3273,7 +3650,9 @@ boolean ## languages.python.venv.quiet -Whether `pip install` should avoid outputting messages during devenv initialisation. + + +Whether ` pip install ` should avoid outputting messages during devenv initialisation. @@ -3292,10 +3671,11 @@ boolean ## languages.python.venv.requirements -Contents of pip requirements.txt file. -This is passed to `pip install -r` during `devenv shell` initialisation. +Contents of pip requirements.txt file. +This is passed to ` pip install -r ` during ` devenv shell ` initialisation. + *Type:* @@ -3313,10 +3693,11 @@ null or strings concatenated with “\\n” or path ## languages.python.version -The Python version to use. -This automatically sets the `languages.python.package` using [nixpkgs-python](https://github.com/cachix/nixpkgs-python). +The Python version to use. +This automatically sets the ` languages.python.package ` using [nixpkgs-python](https://github.com/cachix/nixpkgs-python). + *Type:* @@ -3339,6 +3720,8 @@ null or string ## languages.r.enable + + Whether to enable tools for R development. @@ -3363,6 +3746,8 @@ boolean ## languages.r.package + + The R package to use. @@ -3382,6 +3767,8 @@ package ## languages.racket.enable + + Whether to enable tools for Racket development. @@ -3406,6 +3793,8 @@ boolean ## languages.racket.package + + The Racket package to use. @@ -3425,6 +3814,8 @@ package ## languages.raku.enable + + Whether to enable tools for Raku development. @@ -3449,6 +3840,8 @@ boolean ## languages.robotframework.enable + + Whether to enable tools for Robot Framework development. @@ -3473,6 +3866,8 @@ boolean ## languages.robotframework.python + + The Python package to use. @@ -3492,6 +3887,8 @@ package ## languages.ruby.enable + + Whether to enable tools for Ruby development. @@ -3516,6 +3913,8 @@ boolean ## languages.ruby.package + + The Ruby package to use. @@ -3535,6 +3934,8 @@ package ## languages.ruby.bundler.enable + + Whether to enable bundler. @@ -3559,6 +3960,8 @@ boolean ## languages.ruby.bundler.package + + The bundler package to use. @@ -3578,10 +3981,11 @@ package ## languages.ruby.version -The Ruby version to use. -This automatically sets the `languages.ruby.package` using [nixpkgs-ruby](https://github.com/bobvanderlinden/nixpkgs-ruby). +The Ruby version to use. +This automatically sets the ` languages.ruby.package ` using [nixpkgs-ruby](https://github.com/bobvanderlinden/nixpkgs-ruby). + *Type:* @@ -3604,9 +4008,11 @@ null or string ## 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: +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; @@ -3614,7 +4020,6 @@ languages.ruby.versionFile = ./.ruby-version; - *Type:* null or path @@ -3639,6 +4044,8 @@ null or path ## languages.rust.enable + + Whether to enable tools for Rust development. @@ -3663,6 +4070,8 @@ boolean ## languages.rust.channel + + The rustup toolchain to install. @@ -3682,10 +4091,11 @@ one of “nixpkgs”, “stable”, “beta”, “nightly” ## languages.rust.components -List of [Rustup components](https://rust-lang.github.io/rustup/concepts/components.html) -to install. Defaults to those available in `nixpkgs`. +List of [Rustup components](https://rust-lang.github.io/rustup/concepts/components.html) +to install. Defaults to those available in ` nixpkgs `. + *Type:* @@ -3703,7 +4113,9 @@ list of string ## languages.rust.toolchain -Rust component packages. May optionally define additional components, for example `miri`. + + +Rust component packages. May optionally define additional components, for example ` miri `. @@ -3722,6 +4134,8 @@ attribute set of package ## languages.rust.toolchain.cargo + + cargo package @@ -3741,6 +4155,8 @@ null or package ## languages.rust.toolchain.clippy + + clippy package @@ -3760,6 +4176,8 @@ null or package ## languages.rust.toolchain.rust-analyzer + + rust-analyzer package @@ -3779,6 +4197,8 @@ null or package ## languages.rust.toolchain.rustc + + rustc package @@ -3798,6 +4218,8 @@ null or package ## languages.rust.toolchain.rustfmt + + rustfmt package @@ -3817,6 +4239,8 @@ null or package ## languages.scala.enable + + Whether to enable tools for Scala development. @@ -3841,9 +4265,10 @@ boolean ## languages.scala.package -The Scala package to use. +The Scala package to use. + *Type:* @@ -3861,6 +4286,8 @@ package ## languages.shell.enable + + Whether to enable tools for shell development. @@ -3885,6 +4312,8 @@ boolean ## languages.standardml.enable + + Whether to enable tools for Standard ML development. @@ -3909,9 +4338,10 @@ boolean ## languages.standardml.package -The Standard ML package to use. +The Standard ML package to use. + *Type:* @@ -3929,6 +4359,8 @@ package ## languages.swift.enable + + Whether to enable tools for Swift development. @@ -3953,9 +4385,10 @@ boolean ## languages.swift.package -The Swift package to use. +The Swift package to use. + *Type:* @@ -3973,6 +4406,8 @@ package ## languages.terraform.enable + + Whether to enable tools for Terraform development. @@ -3997,6 +4432,8 @@ boolean ## languages.terraform.package + + The Terraform package to use. @@ -4016,6 +4453,8 @@ package ## languages.texlive.enable + + Whether to enable TeX Live. @@ -4040,12 +4479,14 @@ boolean ## languages.texlive.packages + + Packages available to TeX Live *Type:* -non-empty (list of Concatenated string) +non-empty (list of string) @@ -4064,7 +4505,9 @@ non-empty (list of Concatenated string) ## languages.texlive.base -TeX Live package set to use + + +TeX Live package set to use @@ -4083,6 +4526,8 @@ unspecified value ## languages.typescript.enable + + Whether to enable tools for TypeScript development. @@ -4107,6 +4552,8 @@ boolean ## languages.unison.enable + + Whether to enable tools for Unison development. @@ -4131,6 +4578,8 @@ boolean ## languages.unison.package + + Which package of Unison to use @@ -4150,6 +4599,8 @@ package ## languages.v.enable + + Whether to enable tools for V development. @@ -4174,6 +4625,8 @@ boolean ## languages.v.package + + The V package to use. @@ -4193,6 +4646,8 @@ package ## languages.vala.enable + + Whether to enable tools for Vala development. @@ -4217,6 +4672,8 @@ boolean ## languages.vala.package + + The Vala package to use. @@ -4241,6 +4698,8 @@ package ## languages.zig.enable + + Whether to enable tools for Zig development. @@ -4265,6 +4724,8 @@ boolean ## languages.zig.package + + Which package of Zig to use. @@ -4284,6 +4745,8 @@ package ## name + + Name of the project. @@ -4331,6 +4794,15 @@ 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) @@ -4481,6 +4953,10 @@ Lint Rust code. A tool for formatting Clojure code. +**` cmake-format `** + +A tool for formatting CMake-files. + **` commitizen `** Check whether the current commit message follows committing rules. @@ -4842,6 +5318,8 @@ attribute set of (submodule) ## pre-commit.hooks.\.enable + + Whether to enable this pre-commit hook. @@ -5204,6 +5682,11 @@ 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) @@ -5425,7 +5908,7 @@ string *Default:* ``` -"${pkgs.autoflake}/bin/autoflake" +"${tools.autoflake}/bin/autoflake" ``` @@ -5518,6 +6001,32 @@ boolean +## pre-commit.settings.cmake-format.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.settings.credo.strict @@ -6001,8 +6510,39 @@ string *Default:* ``` -"${pkgs.python39Packages.flake8}/bin/flake8" +"${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.settings.flake8.extendIgnore + + + +List of additional ignore codes + + + +*Type:* +list of string + + + +*Default:* +` [ ] ` + + + +*Example:* + +``` +[ + "E501" +] ``` *Declared by:* @@ -6045,7 +6585,7 @@ package *Default:* -` "\${pkgs.python311Packages.flynt}" ` +` "\${tools.flynt}" ` @@ -6813,7 +7353,7 @@ path *Default:* ``` -"${pkgs.python311Packages.mkdocs-linkcheck}/bin/mkdocs-linkcheck" +"${tools.mkdocs-linkcheck}/bin/mkdocs-linkcheck" ``` @@ -6845,8 +7385,6 @@ string ## pre-commit.settings.mkdocs-linkcheck.local-only - - Whether to only check local links. @@ -6943,7 +7481,7 @@ string *Default:* ``` -"${pkgs.mypy}/bin/mypy" +"${tools.mypy}/bin/mypy" ``` @@ -7017,6 +7555,8 @@ list of string ## pre-commit.settings.php-cs-fixer.binPath + + PHP-CS-Fixer binary path. @@ -7029,7 +7569,7 @@ string *Default:* ``` -"${pkgs.php81Packages.php-cs-fixer}/bin/php-cs-fixer" +"${tools.php-cs-fixer}/bin/php-cs-fixer" ``` @@ -7054,7 +7594,7 @@ string *Default:* ``` -"${pkgs.php80Packages.phpcbf}/bin/phpcbf" +"${tools.phpcbf}/bin/phpcbf" ``` @@ -7079,7 +7619,7 @@ string *Default:* ``` -"${pkgs.php80Packages.phpcs}/bin/phpcs" +"${tools.phpcs}/bin/phpcs" ``` @@ -7104,7 +7644,7 @@ string *Default:* ``` -"${pkgs.php81Packages.phpstan}/bin/phpstan" +"${tools.phpstan}/bin/phpstan" ``` @@ -7113,57 +7653,57 @@ string -## pre-commit.settings.prettier.binPath +## pre-commit.settings.prettier.allow-parens -` prettier ` binary path. E.g. if you want to use the ` prettier ` in ` node_modules `, use ` ./node_modules/.bin/prettier `. +Include parentheses around a sole arrow function parameter. *Type:* -path +one of “always”, “avoid” *Default:* - -``` -"${tools.prettier}/bin/prettier" - -``` +` "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.settings.prettier.output +## pre-commit.settings.prettier.binPath -Output format. +` prettier ` binary path. E.g. if you want to use the ` prettier ` in ` node_modules `, use ` ./node_modules/.bin/prettier `. *Type:* -null or one of “check”, “list-different” +path *Default:* -` "list-different" ` + +``` +"${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.settings.prettier.write +## pre-commit.settings.prettier.bracket-same-line -Whether to edit files inplace. +Put > of opening tags on the last line instead of on a new line. @@ -7173,43 +7713,39 @@ boolean *Default:* -` true ` +` 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.settings.psalm.binPath +## pre-commit.settings.prettier.cache -Psalm binary path. +Only format changed files. *Type:* -string +boolean *Default:* - -``` -"${pkgs.php81Packages.phpstan}/bin/psalm" - -``` +` 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.settings.pylint.binPath +## pre-commit.settings.prettier.cache-location -Pylint binary path. Should be used to specify Pylint binary from your Nix-managed Python environment. +Path to the cache file location used by ` --cache ` flag. @@ -7219,43 +7755,39 @@ string *Default:* - -``` -"${pkgs.python39Packages.pylint}/bin/pylint" - -``` +` "./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.settings.pylint.reports +## pre-commit.settings.prettier.cache-strategy -Whether to display a full report. +Strategy for the cache to use for detecting changed files. *Type:* -boolean +null or one of “metadata”, “content” *Default:* -` false ` +` 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.settings.pylint.score +## pre-commit.settings.prettier.check -Whether to activate the evaluation score. +Output a human-friendly message and a list of unformatted files, if any. @@ -7265,68 +7797,60 @@ boolean *Default:* -` true ` +` 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.settings.pyright.binPath +## pre-commit.settings.prettier.color -Pyright binary path. Should be used to specify the pyright executable in an environment containing your typing stubs. +Colorize error messages. *Type:* -string +boolean *Default:* - -``` -"${pkgs.pyright}/bin/pyright" - -``` +` 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.settings.pyupgrade.binPath +## pre-commit.settings.prettier.config-precedence -pyupgrade binary path. Should be used to specify the pyupgrade binary from your Nix-managed Python environment. +Defines how config file should be evaluated in combination of CLI options. *Type:* -string +one of “cli-override”, “file-override”, “prefer-file” *Default:* - -``` -"${pkgs.pyupgrade}/bin/pyupgrade" - -``` +` "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.settings.revive.configPath +## pre-commit.settings.prettier.configPath -Path to the configuration TOML file. +Path to a Prettier configuration file (.prettierrc, package.json, prettier.config.js). @@ -7343,263 +7867,228 @@ string -## pre-commit.settings.rome.binPath +## pre-commit.settings.prettier.embedded-language-formatting -` rome ` binary path. E.g. if you want to use the ` rome ` in ` node_modules `, use ` ./node_modules/.bin/rome `. +Control how Prettier formats quoted code embedded in the file. *Type:* -path +one of “auto”, “off” *Default:* -` "\${pkgs.rome}/bin/rome" ` +` "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.settings.rome.configPath +## pre-commit.settings.prettier.end-of-line -Path to the configuration JSON file +Which end of line characters to apply. *Type:* -string +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.settings.rome.write +## pre-commit.settings.prettier.html-whitespace-sensitivity -Whether to edit files inplace. +How to handle whitespaces in HTML. *Type:* -boolean +one of “css”, “strict”, “ignore” *Default:* -` true ` +` "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.settings.rust.cargoManifestPath +## pre-commit.settings.prettier.ignore-path -Path to Cargo.toml +Path to a file containing patterns that describe files to ignore. +By default, prettier looks for ` ./.gitignore ` and ` ./.prettierignore `. +Multiple values are accepted. *Type:* -null or string +list of 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.settings.statix.format +## pre-commit.settings.prettier.ignore-unknown -Error Output format. +Ignore unknown files. *Type:* -one of “stderr”, “errfmt”, “json” +boolean *Default:* -` "errfmt" ` +` 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.settings.statix.ignore +## pre-commit.settings.prettier.insert-pragma -Globs of file patterns to skip. +Insert @format pragma into file’s first docblock comment. *Type:* -list of string +boolean *Default:* -` [ ] ` - - - -*Example:* - -``` -[ - "flake.nix" - "_*" -] -``` +` 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.settings.treefmt.package +## pre-commit.settings.prettier.jsx-single-quote -The ` treefmt ` package to use. +Use single quotes in JSX. -Should include all the formatters configured by treefmt. -For example: -```nix -pkgs.writeShellApplication { - name = "treefmt"; - runtimeInputs = [ - pkgs.treefmt - pkgs.nixpkgs-fmt - pkgs.black - ]; - text = - '' - exec treefmt "$@" - ''; -} -``` +*Type:* +boolean -*Type:* -package +*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.settings.typos.color +## pre-commit.settings.prettier.list-different -When to use generate output. +Print the filenames of files that are different from Prettier formatting. *Type:* -one of “auto”, “always”, “never” +boolean *Default:* -` "auto" ` +` 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.settings.typos.config +## pre-commit.settings.prettier.log-level -Multiline-string configuration passed as config file. +What level of logs to report. *Type:* -string +one of “silent”, “error”, “warn”, “log”, “debug” *Default:* -` "" ` +` "log" ` *Example:* - -``` -'' - [files] - ignore-dot = true - - [default] - binary = false - - [type.py] - extend-glob = [] -'' -``` +` "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.settings.typos.configPath +## pre-commit.settings.prettier.no-bracket-spacing -Path to a custom config file. +Do not print spaces between brackets. *Type:* -string +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.settings.typos.diff +## pre-commit.settings.prettier.no-config -Whether to print a diff of what would change. +Do not look for a configuration file. @@ -7616,58 +8105,1014 @@ boolean -## pre-commit.settings.typos.exclude +## pre-commit.settings.prettier.no-editorconfig -Which files \& directories to exclude matching the glob. +Don’t take .editorconfig into account when parsing configuration. *Type:* -string +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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.prettier.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.settings.psalm.binPath + + + +Psalm binary path. + + + +*Type:* +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.settings.pylint.binPath + + + +Pylint binary path. Should be used to specify Pylint binary from your Nix-managed Python environment. + + + +*Type:* +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.settings.pylint.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.settings.pylint.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.settings.pyright.binPath + + + +Pyright binary path. Should be used to specify the pyright executable in an environment containing your typing stubs. + + + +*Type:* +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.settings.pyupgrade.binPath + + + +pyupgrade binary path. Should be used to specify the pyupgrade binary from your Nix-managed Python environment. + + + +*Type:* +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.settings.revive.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.settings.rome.binPath + + + +` rome ` binary path. E.g. if you want to use the ` rome ` in ` node_modules `, use ` ./node_modules/.bin/rome `. + + + +*Type:* +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.settings.rome.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.settings.rome.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.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.settings.statix.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.settings.statix.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.settings.treefmt.package + + + +The ` treefmt ` package to use. + +Should include all the formatters configured by treefmt. + +For example: + +```nix +pkgs.writeShellApplication { + name = "treefmt"; + runtimeInputs = [ + pkgs.treefmt + pkgs.nixpkgs-fmt + pkgs.black + ]; + text = + '' + exec treefmt "$@" + ''; +} +``` + + + +*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.settings.typos.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.settings.typos.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.settings.typos.config + + + +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.settings.typos.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.settings.typos.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.settings.typos.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.settings.typos.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.settings.typos.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.settings.typos.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.settings.typos.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.settings.typos.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.settings.typos.no-check-files + + + +Skip verifying spelling in files. + + + +*Type:* +boolean *Default:* -` "" ` - - - -*Example:* -` "*.nix" ` +` 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.settings.typos.format +## pre-commit.settings.typos.no-unicode -Which output format to use. +Only allow ASCII characters in identifiers. *Type:* -one of “silent”, “brief”, “long”, “json” +boolean *Default:* -` "long" ` +` 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.settings.typos.hidden +## pre-commit.settings.typos.quiet -Whether to search hidden files and directories. +Less output per occurence. @@ -7684,21 +9129,21 @@ boolean -## pre-commit.settings.typos.locale +## pre-commit.settings.typos.verbose -Which language to use for spell checking. +More output per occurence. *Type:* -one of “en”, “en-us”, “en-gb”, “en-ca”, “en-au” +boolean *Default:* -` "en" ` +` 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) @@ -7709,7 +9154,7 @@ one of “en”, “en-us”, “en-gb”, “en-ca”, “en-au” -Whether to fix spelling in files by writing them. Cannot be used with ` typos.settings.diff `. +Fix spelling in files by writing them. Cannot be used with ` typos.settings.diff `. @@ -7876,6 +9321,11 @@ Tool set from which ` nix-pre-commit-hooks ` will pick binaries. *Type:* lazy attribute set of (null or package) + + +*Default:* +` pre-commit-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) @@ -7883,6 +9333,8 @@ lazy attribute set of (null or package) ## process.after + + Bash code to execute after stopping processes. @@ -7902,6 +9354,8 @@ strings concatenated with “\\n” ## process.before + + Bash code to execute before starting processes. @@ -7921,7 +9375,9 @@ strings concatenated with “\\n” ## process.implementation -The implementation used when performing ``devenv up``. + + +The implementation used when performing ` devenv up `. @@ -7931,7 +9387,7 @@ one of “honcho”, “overmind”, “process-compose”, “hivemind” *Default:* -` "honcho" ` +` "process-compose" ` @@ -7945,9 +9401,10 @@ one of “honcho”, “overmind”, “process-compose”, “hivemind” ## process.process-compose -Top-level process-compose.yaml options when that implementation is used. +Top-level process-compose.yaml options when that implementation is used. + *Type:* @@ -7984,6 +9441,8 @@ attribute set ## process-managers.hivemind.enable + + Whether to enable hivemind as process-manager. @@ -8008,6 +9467,8 @@ boolean ## process-managers.hivemind.package + + The hivemind package to use. @@ -8027,6 +9488,8 @@ package ## process-managers.honcho.enable + + Whether to enable honcho as process-manager. @@ -8051,6 +9514,8 @@ boolean ## process-managers.honcho.package + + The honcho package to use. @@ -8070,6 +9535,8 @@ package ## process-managers.overmind.enable + + Whether to enable overmind as process-manager. @@ -8094,6 +9561,8 @@ boolean ## process-managers.overmind.package + + The overmind package to use. @@ -8113,6 +9582,8 @@ package ## process-managers.process-compose.enable + + Whether to enable process-compose as process-manager. @@ -8137,6 +9608,8 @@ boolean ## process-managers.process-compose.package + + The process-compose package to use. @@ -8156,10 +9629,11 @@ package ## process-managers.process-compose.settings -process-compose.yaml specific process attributes. -Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml` +process-compose.yaml specific process attributes. + +Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\` @@ -8200,7 +9674,9 @@ YAML value ## processes -Processes can be started with ``devenv up`` and run in foreground mode. + + +Processes can be started with ` devenv up ` and run in foreground mode. @@ -8219,6 +9695,8 @@ attribute set of (submodule) ## processes.\.exec + + Bash code to run the process. @@ -8233,12 +9711,13 @@ string ## 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.implementation = "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.implementation = "process-compose"; ` @@ -8279,6 +9758,8 @@ attribute set ## scripts + + A set of scripts available when the environment is active. @@ -8298,6 +9779,8 @@ attribute set of (submodule) ## scripts.\.description + + Description of the script. @@ -8317,6 +9800,8 @@ string ## scripts.\.exec + + Bash code to execute when the script is run. @@ -8331,6 +9816,8 @@ string ## services.adminer.enable + + Whether to enable Adminer process. @@ -8355,6 +9842,8 @@ boolean ## services.adminer.package + + Which package of Adminer to use. @@ -8374,6 +9863,8 @@ package ## services.adminer.listen + + Listen address for the Adminer. @@ -8393,6 +9884,8 @@ string ## services.blackfire.enable + + Whether to enable Blackfire profiler agent It automatically installs Blackfire PHP extension. @@ -8420,6 +9913,8 @@ boolean ## services.blackfire.enableApm + + Whether to enable Enables application performance monitoring, requires special subscription. . @@ -8445,6 +9940,8 @@ boolean ## services.blackfire.package + + Which package of blackfire to use @@ -8464,10 +9961,11 @@ package ## services.blackfire.client-id -Sets the client id used to authenticate with Blackfire. -You can find your personal client-id at . +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:* @@ -8485,10 +9983,11 @@ string ## services.blackfire.client-token -Sets the client token used to authenticate with Blackfire. -You can find your personal client-token at . +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:* @@ -8506,10 +10005,11 @@ string ## services.blackfire.server-id -Sets the server id used to authenticate with Blackfire. -You can find your personal server-id at . +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:* @@ -8527,10 +10027,11 @@ string ## services.blackfire.server-token -Sets the server token used to authenticate with Blackfire. -You can find your personal server-token at . +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:* @@ -8548,9 +10049,10 @@ string ## services.blackfire.socket -Sets the server socket path +Sets the server socket path + *Type:* @@ -8568,6 +10070,8 @@ string ## services.caddy.enable + + Whether to enable Caddy web server. @@ -8592,9 +10096,10 @@ boolean ## services.caddy.package -Caddy package to use. +Caddy package to use. + *Type:* @@ -8612,10 +10117,11 @@ package ## services.caddy.adapter -Name of the config adapter to use. -See for the full list. +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:* @@ -8638,14 +10144,15 @@ string ## services.caddy.ca -Certificate authority ACME server. The default (Let's Encrypt + + +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 +you don’t want to include any authority (or if you want to write a more fine-graned configuration manually). - *Type:* null or string @@ -8666,10 +10173,11 @@ null or string ## services.caddy.config -Verbatim Caddyfile to use. -Caddy v2 supports multiple config formats via adapters (see [`services.caddy.adapter`](#servicescaddyconfig)). +Verbatim Caddyfile to use. +Caddy v2 supports multiple config formats via adapters (see [` services.caddy.adapter `](\#servicescaddyconfig)). + *Type:* @@ -8701,12 +10209,13 @@ strings concatenated with “\\n” ## 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 . - +See [https://caddyserver.com/docs/conventions\#file-locations](https://caddyserver.com/docs/conventions\#file-locations). @@ -8725,7 +10234,9 @@ path ## services.caddy.email -Email address (for Let's Encrypt certificate). + + +Email address (for Let’s Encrypt certificate). @@ -8744,9 +10255,10 @@ string ## services.caddy.resume -Use saved config, if any (and prefer over configuration passed with [`caddy.config`](#caddyconfig)). +Use saved config, if any (and prefer over configuration passed with [` caddy.config `](\#caddyconfig)). + *Type:* @@ -8764,6 +10276,8 @@ boolean ## services.caddy.virtualHosts + + Declarative vhost config. @@ -8801,9 +10315,10 @@ attribute set of (submodule) ## services.caddy.virtualHosts.\.extraConfig -These lines go into the vhost verbatim. +These lines go into the vhost verbatim. + *Type:* @@ -8821,9 +10336,10 @@ strings concatenated with “\\n” ## services.caddy.virtualHosts.\.serverAliases -Additional names of virtual hosts served by this virtual host configuration. +Additional names of virtual hosts served by this virtual host configuration. + *Type:* @@ -8852,7 +10368,9 @@ list of string ## services.cassandra.enable -Whether to enable Add Cassandra process script.. + + +Whether to enable Add Cassandra process script… @@ -8876,6 +10394,8 @@ boolean ## services.cassandra.package + + Which version of Cassandra to use @@ -8900,9 +10420,10 @@ package ## services.cassandra.allowClients -Enables or disables the native transport server (CQL binary protocol) +Enables or disables the native transport server (CQL binary protocol) + *Type:* @@ -8920,6 +10441,8 @@ boolean ## services.cassandra.clusterName + + The name of the cluster @@ -8939,9 +10462,10 @@ string ## services.cassandra.extraConfig -Extra options to be merged into `cassandra.yaml` as nix attribute set. +Extra options to be merged into ` cassandra.yaml ` as nix attribute set. + *Type:* @@ -8969,6 +10493,8 @@ attribute set ## services.cassandra.jvmOpts + + Options to pass to the JVM through the JVM_OPTS environment variable @@ -8988,6 +10514,8 @@ list of string ## services.cassandra.listenAddress + + Listen address @@ -9012,6 +10540,8 @@ string ## services.cassandra.seedAddresses + + The addresses of hosts designated as contact points of the cluster @@ -9036,6 +10566,8 @@ list of string ## services.clickhouse.enable + + Whether to enable clickhouse-server. @@ -9060,6 +10592,8 @@ boolean ## services.clickhouse.package + + Which package of clickhouse to use @@ -9079,6 +10613,8 @@ package ## services.clickhouse.config + + ClickHouse configuration in YAML. @@ -9093,6 +10629,8 @@ strings concatenated with “\\n” ## services.clickhouse.port + + Which port to run clickhouse on @@ -9112,6 +10650,8 @@ signed integer ## services.cockroachdb.enable + + Whether to enable Add CockroachDB process. . @@ -9137,6 +10677,8 @@ boolean ## services.cockroachdb.package + + The CockroachDB package to use. @@ -9156,9 +10698,10 @@ unspecified value ## services.cockroachdb.http_addr -The hostname or IP address to bind to for HTTP requests. +The hostname or IP address to bind to for HTTP requests. + *Type:* @@ -9176,9 +10719,10 @@ string ## services.cockroachdb.listen_addr -The address/hostname and port to listen on. +The address/hostname and port to listen on. + *Type:* @@ -9196,6 +10740,8 @@ string ## services.couchdb.enable + + Whether to enable CouchDB process. @@ -9220,6 +10766,8 @@ boolean ## services.couchdb.package + + Which version of CouchDB to use @@ -9239,17 +10787,18 @@ package ## services.couchdb.settings + + CouchDB configuration. to know more about all settings, look at: - - *Type:* -attribute set of attribute set of (INI atom (null, bool, int, float or string)) +attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string)) @@ -9328,13 +10877,14 @@ Defined the port number to listen. ## services.couchdb.settings.couchdb.database_dir -Specifies location of CouchDB database files (*.couch named). This + + +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 @@ -9350,13 +10900,14 @@ path ## 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 @@ -9372,6 +10923,8 @@ boolean ## 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 @@ -9380,7 +10933,6 @@ runs the CouchDB service (couchdb by default). - *Type:* path @@ -9396,13 +10948,14 @@ path ## 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 @@ -9418,6 +10971,8 @@ path ## services.dynamodb-local.enable + + Whether to enable DynamoDB Local. @@ -9442,6 +10997,8 @@ boolean ## services.dynamodb-local.package + + Which package of DynamoDB to use. @@ -9461,6 +11018,8 @@ package ## services.dynamodb-local.port + + Listen address for the Dynamodb-local. @@ -9480,6 +11039,8 @@ Listen address for the Dynamodb-local. ## services.elasticmq.enable + + Whether to enable elasticmq-server. @@ -9504,6 +11065,8 @@ boolean ## services.elasticmq.package + + Which package of elasticmq-server-bin to use @@ -9523,6 +11086,8 @@ package ## services.elasticmq.settings + + Configuration for elasticmq-server @@ -9542,6 +11107,8 @@ strings concatenated with “\\n” ## services.elasticsearch.enable + + Whether to enable elasticsearch. @@ -9561,6 +11128,8 @@ boolean ## services.elasticsearch.package + + Elasticsearch package to use. @@ -9580,6 +11149,8 @@ package ## services.elasticsearch.cluster_name + + Elasticsearch name that identifies your cluster for auto-discovery. @@ -9599,6 +11170,8 @@ string ## services.elasticsearch.extraCmdLineOptions + + Extra command line options for the elasticsearch launcher. @@ -9618,6 +11191,8 @@ list of string ## services.elasticsearch.extraConf + + Extra configuration for elasticsearch. @@ -9649,6 +11224,8 @@ string ## services.elasticsearch.extraJavaOptions + + Extra command line options for Java. @@ -9678,6 +11255,8 @@ list of string ## services.elasticsearch.listenAddress + + Elasticsearch listen address. @@ -9697,6 +11276,8 @@ string ## services.elasticsearch.logging + + Elasticsearch logging configuration. @@ -9728,6 +11309,8 @@ string ## services.elasticsearch.plugins + + Extra elasticsearch plugins @@ -9752,6 +11335,8 @@ list of package ## services.elasticsearch.port + + Elasticsearch port to listen for HTTP traffic. @@ -9771,6 +11356,8 @@ signed integer ## services.elasticsearch.single_node + + Start a single-node cluster @@ -9790,6 +11377,8 @@ boolean ## services.elasticsearch.tcp_port + + Elasticsearch port for the node to node communication. @@ -9809,6 +11398,8 @@ signed integer ## services.influxdb.enable + + Whether to enable influxdb. @@ -9833,6 +11424,8 @@ boolean ## services.influxdb.package + + An open-source distributed time series database @@ -9852,6 +11445,8 @@ package ## services.influxdb.config + + Configuration for InfluxDB-server @@ -9871,6 +11466,8 @@ strings concatenated with “\\n” ## services.mailhog.enable + + Whether to enable mailhog process. @@ -9895,6 +11492,8 @@ boolean ## services.mailhog.package + + Which package of mailhog to use @@ -9914,9 +11513,10 @@ package ## services.mailhog.additionalArgs -Additional arguments passed to `mailhog`. +Additional arguments passed to ` mailhog `. + *Type:* @@ -9944,6 +11544,8 @@ list of strings concatenated with “\\n” ## services.mailhog.apiListenAddress + + Listen address for API. @@ -9963,6 +11565,8 @@ string ## services.mailhog.smtpListenAddress + + Listen address for SMTP. @@ -9982,6 +11586,8 @@ string ## services.mailhog.uiListenAddress + + Listen address for UI. @@ -10001,6 +11607,8 @@ string ## services.mailpit.enable + + Whether to enable mailpit process. @@ -10025,6 +11633,8 @@ boolean ## services.mailpit.package + + Which package of mailpit to use @@ -10044,9 +11654,10 @@ package ## services.mailpit.additionalArgs -Additional arguments passed to `mailpit`. +Additional arguments passed to ` mailpit `. + *Type:* @@ -10074,6 +11685,8 @@ list of strings concatenated with “\\n” ## services.mailpit.smtpListenAddress + + Listen address for SMTP. @@ -10093,6 +11706,8 @@ string ## services.mailpit.uiListenAddress + + Listen address for UI. @@ -10112,6 +11727,8 @@ string ## services.meilisearch.enable + + Whether to enable Meilisearch. @@ -10136,6 +11753,8 @@ boolean ## services.meilisearch.environment + + Defines the running environment of Meilisearch. @@ -10155,6 +11774,8 @@ one of “development”, “production” ## services.meilisearch.listenAddress + + Meilisearch listen address. @@ -10174,6 +11795,8 @@ string ## services.meilisearch.listenPort + + Meilisearch port to listen on. @@ -10193,14 +11816,16 @@ Meilisearch port to listen on. ## services.meilisearch.logLevel -Defines how much detail should be present in Meilisearch's logs. + + +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 + - ‘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 @@ -10219,14 +11844,15 @@ string ## 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'. +For example, the default value can be written as 107374182400, ‘107.7Gb’, or ‘107374 Mb’. Default is 100 GiB - *Type:* string @@ -10242,6 +11868,8 @@ string ## services.meilisearch.noAnalytics + + Deactivates analytics. Analytics allow Meilisearch to know how many users are using Meilisearch, which versions and which platforms are used. @@ -10249,7 +11877,6 @@ This process is entirely anonymous. - *Type:* boolean @@ -10265,6 +11892,8 @@ boolean ## services.memcached.enable + + Whether to enable memcached process. @@ -10289,6 +11918,8 @@ boolean ## services.memcached.package + + Which package of memcached to use @@ -10308,9 +11939,10 @@ package ## services.memcached.bind + + The IP interface to bind to. -`null` means "all interfaces". - +` null ` means “all interfaces”. @@ -10334,12 +11966,13 @@ null or string ## services.memcached.port + + The TCP port to accept connections. If port 0 is specified Redis will not listen on a TCP socket. - *Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive) @@ -10355,9 +11988,10 @@ If port 0 is specified Redis will not listen on a TCP socket. ## services.memcached.startArgs -Additional arguments passed to `memcached` during startup. +Additional arguments passed to ` memcached ` during startup. + *Type:* @@ -10385,6 +12019,8 @@ list of strings concatenated with “\\n” ## services.minio.enable + + Whether to enable MinIO Object Storage. @@ -10409,6 +12045,8 @@ boolean ## services.minio.package + + MinIO package to use. @@ -10428,9 +12066,10 @@ package ## services.minio.accessKey -Access key of 5 to 20 characters in length that clients use to access the server. +Access key of 5 to 20 characters in length that clients use to access the server. + *Type:* @@ -10448,6 +12087,8 @@ string ## services.minio.afterStart + + Bash code to execute after minio is running. @@ -10477,6 +12118,8 @@ strings concatenated with “\\n” ## services.minio.browser + + Enable or disable access to web UI. @@ -10496,9 +12139,10 @@ boolean ## services.minio.buckets -List of buckets to ensure exist on startup. +List of buckets to ensure exist on startup. + *Type:* @@ -10516,11 +12160,12 @@ list of string ## 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. +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. @@ -10534,6 +12179,8 @@ null or JSON value ## services.minio.clientPackage + + MinIO client package to use. @@ -10553,6 +12200,8 @@ package ## services.minio.consoleAddress + + IP address and port of the web UI (console). @@ -10572,6 +12221,8 @@ string ## services.minio.listenAddress + + IP address and port of the server. @@ -10591,9 +12242,10 @@ string ## 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. +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:* @@ -10611,9 +12263,10 @@ string ## services.minio.secretKey -Specify the Secret key of 8 to 40 characters in length that clients use to access the server. +Specify the Secret key of 8 to 40 characters in length that clients use to access the server. + *Type:* @@ -10631,6 +12284,8 @@ string ## services.mongodb.enable + + Whether to enable MongoDB process and expose utilities. @@ -10655,6 +12310,8 @@ boolean ## services.mongodb.package + + Which MongoDB package to use. @@ -10674,9 +12331,10 @@ package ## services.mongodb.additionalArgs -Additional arguments passed to `mongod`. +Additional arguments passed to ` mongod `. + *Type:* @@ -10711,6 +12369,8 @@ list of strings concatenated with “\\n” ## services.mysql.enable + + Whether to enable MySQL process and expose utilities. @@ -10735,6 +12395,8 @@ boolean ## services.mysql.package + + Which package of MySQL to use @@ -10754,6 +12416,8 @@ package ## 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. @@ -10763,7 +12427,6 @@ otherwise have to be removed manually. - *Type:* list of (submodule) @@ -10795,6 +12458,8 @@ list of (submodule) ## 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. @@ -10803,8 +12468,7 @@ 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}`. - +The attributes are used as ` GRANT ${attrName} ON ${attrValue} `. @@ -10835,9 +12499,10 @@ attribute set of string ## services.mysql.ensureUsers.\*.name -Name of the user to ensure. +Name of the user to ensure. + *Type:* @@ -10850,9 +12515,10 @@ string ## services.mysql.ensureUsers.\*.password -Password of the user to ensure. +Password of the user to ensure. + *Type:* @@ -10870,9 +12536,10 @@ null or string ## services.mysql.importTimeZones -Whether to import tzdata on the first startup of the mysql server +Whether to import tzdata on the first startup of the mysql server + *Type:* @@ -10890,12 +12557,13 @@ null or boolean ## 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) @@ -10923,9 +12591,10 @@ list of (submodule) ## services.mysql.initialDatabases.\*.name -The name of the database to create. +The name of the database to create. + *Type:* @@ -10938,12 +12607,13 @@ string ## services.mysql.initialDatabases.\*.schema + + The initial schema of the database; if null (the default), an empty database is created. - *Type:* null or path @@ -10959,9 +12629,10 @@ null or path ## services.mysql.settings -MySQL configuration. +MySQL configuration. + *Type:* @@ -10999,6 +12670,8 @@ lazy attribute set of lazy attribute set of anything ## 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. @@ -11006,7 +12679,6 @@ This option does not affect the mysqld command. - *Type:* boolean @@ -11022,6 +12694,8 @@ boolean ## services.nginx.enable + + Whether to enable nginx. @@ -11046,6 +12720,8 @@ boolean ## services.nginx.package + + The nginx package to use. @@ -11093,6 +12769,8 @@ path ## services.nginx.eventsConfig + + The nginx events configuration. @@ -11112,6 +12790,8 @@ strings concatenated with “\\n” ## services.nginx.httpConfig + + The nginx configuration. @@ -11178,6 +12858,8 @@ package ## services.opensearch.extraCmdLineOptions + + Extra command line options for the OpenSearch launcher. @@ -11197,6 +12879,8 @@ list of string ## services.opensearch.extraJavaOptions + + Extra command line options for Java. @@ -11385,6 +13069,8 @@ The port to listen on for transport traffic. ## services.postgres.enable + + Whether to enable Add PostgreSQL process. . @@ -11410,9 +13096,10 @@ boolean ## services.postgres.package -The PostgreSQL package to use. Use this to override the default with a specific version. +The PostgreSQL package to use. Use this to override the default with a specific version. + *Type:* @@ -11439,9 +13126,10 @@ pkgs.postgresql_15 ## services.postgres.createDatabase -Create a database named like current user on startup. Only applies when initialDatabases is an empty list. +Create a database named like current user on startup. Only applies when initialDatabases is an empty list. + *Type:* @@ -11459,50 +13147,64 @@ boolean ## services.postgres.extensions -Additional PostgreSQL extensions to install. -The available extensions are: -- age -- cstore_fdw -- jsonb_deep_sum -- periods -- pg_auto_failover -- pg_bigm -- pg_cron -- pg_ed25519 -- pg_hint_plan -- pg_hll -- pg_ivm -- pg_partman -- pg_rational -- pg_relusage -- pg_repack -- pg_safeupdate -- pg_similarity -- pg_topn -- pgaudit -- pgjwt -- pgroonga -- pgrouting -- pgtap -- pgvector -- pipelinedb -- plpgsql_check -- plr -- plv8 -- postgis -- repmgr -- rum -- smlar -- tds_fdw -- temporal_tables -- timescaledb -- timescaledb_toolkit -- tsearch_extras -- wal2json +Additional PostgreSQL extensions to install. +The available extensions are: + - age + - 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_net + - pg_partman + - pg_rational + - pg_relusage + - pg_repack + - 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 @@ -11534,10 +13236,11 @@ extensions: [ ## services.postgres.initdbArgs -Additional arguments passed to `initdb` during data dir -initialisation. +Additional arguments passed to ` initdb ` during data dir +initialisation. + *Type:* @@ -11572,12 +13275,13 @@ list of strings concatenated with “\\n” ## 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) @@ -11608,9 +13312,10 @@ list of (submodule) ## services.postgres.initialDatabases.\*.name -The name of the database to create. +The name of the database to create. + *Type:* @@ -11623,12 +13328,13 @@ string ## services.postgres.initialDatabases.\*.schema + + The initial schema of the database; if null (the default), an empty database is created. - *Type:* null or path @@ -11644,12 +13350,13 @@ null or path ## 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 @@ -11675,6 +13382,8 @@ CREATE ROLE bar; ## services.postgres.listen_addresses + + Listen address @@ -11699,9 +13408,10 @@ string ## services.postgres.port -The TCP port to accept connections. +The TCP port to accept connections. + *Type:* @@ -11719,16 +13429,17 @@ The TCP port to accept connections. ## services.postgres.settings + + PostgreSQL configuration. Refer to - -for an overview of `postgresql.conf`. +[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) @@ -11759,12 +13470,13 @@ attribute set of (boolean or floating point number or signed integer or string) ## services.rabbitmq.enable + + Whether to enable the RabbitMQ server, an Advanced Message Queuing Protocol (AMQP) broker. - *Type:* boolean @@ -11780,9 +13492,10 @@ boolean ## services.rabbitmq.package -Which rabbitmq package to use. +Which rabbitmq package to use. + *Type:* @@ -11800,18 +13513,19 @@ package ## services.rabbitmq.configItems -Configuration options in RabbitMQ's new config file format, + + +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, +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` +` config ` option. Configuration from ` config ` will be merged into these options by RabbitMQ at runtime to form the final configuration. -See -For the distinct formats, see - +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) @@ -11842,13 +13556,14 @@ attribute set of string ## 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 @@ -11864,19 +13579,20 @@ string ## 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 +` 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 +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 @@ -11897,6 +13613,8 @@ string ## services.rabbitmq.managementPlugin.enable + + Whether to enable the management plugin. @@ -11921,9 +13639,10 @@ boolean ## services.rabbitmq.managementPlugin.port -On which port to run the management plugin +On which port to run the management plugin + *Type:* @@ -11941,13 +13660,14 @@ On which port to run the management plugin ## 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. - +` name@host `, where ` name ` is an arbitrary name and +` host ` is the domain name of the host. @@ -11966,6 +13686,8 @@ string ## services.rabbitmq.pluginDirs + + The list of directories containing external plugins @@ -11985,6 +13707,8 @@ list of path ## services.rabbitmq.plugins + + The names of plugins to enable @@ -12004,9 +13728,10 @@ list of string ## services.rabbitmq.port -Port on which RabbitMQ will listen for AMQP connections. +Port on which RabbitMQ will listen for AMQP connections. + *Type:* @@ -12024,6 +13749,8 @@ Port on which RabbitMQ will listen for AMQP connections. ## services.redis.enable + + Whether to enable Redis process and expose utilities. @@ -12048,6 +13775,8 @@ boolean ## services.redis.package + + Which package of Redis to use @@ -12067,10 +13796,11 @@ package ## services.redis.bind -The IP interface to bind to. -`null` means "all interfaces". +The IP interface to bind to. +` null ` means “all interfaces”. + *Type:* @@ -12093,7 +13823,9 @@ null or string ## services.redis.extraConfig -Additional text to be appended to `redis.conf`. + + +Additional text to be appended to ` redis.conf `. @@ -12112,12 +13844,13 @@ strings concatenated with “\\n” ## services.redis.port + + The TCP port to accept connections. If port 0 is specified Redis, will not listen on a TCP socket. - *Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive) @@ -12133,6 +13866,8 @@ If port 0 is specified Redis, will not listen on a TCP socket. ## services.temporal.enable + + Whether to enable Temporal process. @@ -12157,6 +13892,8 @@ boolean ## services.temporal.package + + Which package of Temporal to use. @@ -12176,6 +13913,8 @@ package ## services.temporal.ip + + IPv4 address to bind the frontend service to. @@ -12195,7 +13934,9 @@ string ## services.temporal.namespaces -Specify namespaces that should be pre-created (namespace "default" is always created). + + +Specify namespaces that should be pre-created (namespace “default” is always created). @@ -12225,6 +13966,8 @@ list of string ## services.temporal.port + + Port for the frontend gRPC service. @@ -12244,6 +13987,8 @@ Port for the frontend gRPC service. ## services.temporal.state + + State configuration. @@ -12263,6 +14008,8 @@ submodule ## services.temporal.state.ephemeral + + When enabled, the Temporal state gets lost when the process exists. @@ -12282,6 +14029,8 @@ boolean ## services.temporal.state.sqlite-pragma + + Sqlite pragma statements @@ -12312,6 +14061,8 @@ attribute set of string ## services.temporal.ui + + UI configuration. @@ -12331,6 +14082,8 @@ submodule ## services.temporal.ui.enable + + Enable the Web UI. @@ -12350,6 +14103,8 @@ boolean ## services.temporal.ui.ip + + IPv4 address to bind the Web UI to. @@ -12369,6 +14124,8 @@ string ## services.temporal.ui.port + + Port for the Web UI. @@ -12388,6 +14145,8 @@ Port for the Web UI. ## services.varnish.enable + + Whether to enable Varnish process and expose utilities. @@ -12412,6 +14171,8 @@ boolean ## services.varnish.package + + Which Varnish package to use. @@ -12457,6 +14218,8 @@ list of package ## services.varnish.listen + + Which address to listen on. @@ -12476,6 +14239,8 @@ string ## services.varnish.memorySize + + How much memory to allocate to Varnish. @@ -12495,6 +14260,8 @@ string ## services.varnish.vcl + + Varnish VCL configuration. @@ -12524,6 +14291,8 @@ strings concatenated with “\\n” ## services.vault.enable + + Whether to enable vault process. @@ -12548,6 +14317,8 @@ boolean ## services.vault.package + + Which package of Vault to use. @@ -12567,9 +14338,10 @@ package ## services.vault.address -Specifies the address to bind to for listening +Specifies the address to bind to for listening + *Type:* @@ -12587,9 +14359,10 @@ string ## services.vault.disableClustering -Specifies whether clustering features such as request forwarding are enabled +Specifies whether clustering features such as request forwarding are enabled + *Type:* @@ -12607,9 +14380,10 @@ boolean ## services.vault.disableMlock -Disables the server from executing the mlock syscall +Disables the server from executing the mlock syscall + *Type:* @@ -12627,9 +14401,10 @@ boolean ## services.vault.ui -Enables the built-in web UI +Enables the built-in web UI + *Type:* @@ -12647,6 +14422,8 @@ boolean ## services.wiremock.enable + + Whether to enable WireMock. @@ -12671,9 +14448,10 @@ boolean ## services.wiremock.package -Which package of WireMock to use. +Which package of WireMock to use. + *Type:* @@ -12691,9 +14469,10 @@ package ## services.wiremock.disableBanner -Whether to disable print banner logo. +Whether to disable print banner logo. + *Type:* @@ -12711,10 +14490,11 @@ boolean ## services.wiremock.mappings -The mappings to mock. -See the JSON examples on for more information. +The mappings to mock. +See the JSON examples on [https://wiremock.org/docs/stubbing/](https://wiremock.org/docs/stubbing/) for more information. + *Type:* @@ -12766,9 +14546,10 @@ JSON value ## services.wiremock.port -The port number for the HTTP server to listen on. +The port number for the HTTP server to listen on. + *Type:* @@ -12786,9 +14567,10 @@ signed integer ## services.wiremock.verbose -Whether to log verbosely to stdout. +Whether to log verbosely to stdout. + *Type:* @@ -12806,6 +14588,8 @@ boolean ## starship.enable + + Whether to enable the Starship.rs command prompt. @@ -12830,6 +14614,8 @@ boolean ## starship.package + + The Starship package to use. @@ -12849,6 +14635,8 @@ package ## starship.config.enable + + Whether to enable Starship config override. @@ -12873,6 +14661,8 @@ boolean ## starship.config.path + + The Starship configuration file to use. @@ -12889,3 +14679,56 @@ path - [https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix](https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix) + +## unsetEnvVars + + + +Remove these list of env vars from being exported to keep 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" + "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) + +