From c4006ccba1b3e4533de462cee5933e0ccf5f1d6a Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 5 May 2023 12:01:46 +0000 Subject: [PATCH] Auto generate docs/reference/options.md --- docs/reference/options.md | 128 +++++++++++++++++++++++++++++++++++++- 1 file changed, 127 insertions(+), 1 deletion(-) diff --git a/docs/reference/options.md b/docs/reference/options.md index 29c88fa72..efbe85c41 100644 --- a/docs/reference/options.md +++ b/docs/reference/options.md @@ -3219,6 +3219,10 @@ Run ` cabal2nix ` on all ` *.cabal ` files to generate corresponding ` default.n Check the cargo package for errors. +**` checkmake `** + +Experimental linter/analyzer for Makefiles. + **` chktex `** LaTeX semantic checker @@ -3243,6 +3247,10 @@ Scan Nix files for dead code (unused variable bindings). Dhall code formatter. +**` dune-fmt `** + +Runs Dune’s formatters on the code tree. + **` dune-opam-sync `** Check that Dune-generated OPAM files are in sync. @@ -3275,6 +3283,10 @@ Check the style and quality of Python files. Haskell code prettifier. +**` fprettify `** + +Auto-formatter for modern Fortran code. + **` gofmt `** A tool that automatically formats Go source code @@ -3287,6 +3299,10 @@ Run go tests Checks correctness of Go programs. +**` gptcommit `** + +Generate a commit message using GPT3. + **` hadolint `** Dockerfile linter, validate inline bash. @@ -3335,6 +3351,10 @@ Markdown shell pre-processor. Static type checker for Python +**` nil `** + +Incremental analysis assistant for writing in Nix. + **` nixfmt `** Nix code prettifier. @@ -3431,6 +3451,18 @@ Format TOML files with taplo fmt Format terraform (` .tf `) files. +**` tflint `** + +A Pluggable Terraform Linter. + +**` topiary `** + +A universal formatter engine within the Tree-sitter ecosystem, with support for many languages. + +**` treefmt `** + +One CLI to format the code tree. + **` typos `** Source code spell checker @@ -3828,6 +3860,44 @@ list of string +## pre-commit.settings.ansible-lint.configPath + +path to the configuration YAML 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.ansible-lint.subdir + +path to Ansible subdir + + + +*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.autoflake.binPath @@ -4021,6 +4091,27 @@ boolean +## pre-commit.settings.dune-fmt.auto-promote + + + +Whether to auto-promote the changes. + + + +*Type:* +boolean + + + +*Default:* +` true ` + +*Declared by:* + - [https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix](https://github.com/cachix/pre-commit-hooks.nix/blob/master/modules/hooks.nix) + + + ## pre-commit.settings.eslint.binPath @@ -4543,6 +4634,41 @@ list of string +## 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.diff @@ -4677,7 +4803,7 @@ Tool set from which ` nix-pre-commit-hooks ` will pick binaries. *Type:* -lazy attribute set of package +lazy attribute set of (null or package) *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)