Merge branch 'master' into feat/nixfmt-indent/main

Author: shimeoki

README.md

@@ -13,6 +13,8 @@
 
 - Run hooks **as part of development** and **during CI**
 
+- Support for alternative `pre-commit` implementations, like [prek](https://github.com/j178/prek).
+
 ## Getting started
 
 ### devenv.sh
@@ -22,24 +24,38 @@
 
 {
   git-hooks.hooks = {
-    # lint shell scripts
+    # Format Nix code
+    nixfmt.enable = true;
+
+    # Format Python code
+    black.enable = true;
+
+    # Lint shell scripts
     shellcheck.enable = true;
-    # execute example shell from Markdown files
+
+    # Execute shell examples in Markdown files
     mdsh.enable = true;
-    # format Python code
-    black.enable = true;
 
-    # override a package with a different version
+    # Override a package with a different version
     ormolu.enable = true;
     ormolu.package = pkgs.haskellPackages.ormolu;
 
-    # some hooks have more than one package, like clippy:
+    # Some hooks have more than one package, like clippy:
     clippy.enable = true;
     clippy.packageOverrides.cargo = pkgs.cargo;
     clippy.packageOverrides.clippy = pkgs.clippy;
-    # some hooks provide settings
+    # Some hooks provide settings
     clippy.settings.allFeatures = true;
+
+    # Define your own custom hooks
+    my-custom-hook = {
+      name = "My own hook";
+      exec = "on-pre-commit.sh";
+    };
   };
+
+  # Use alternative pre-commit implementations
+  git-hooks.package = pkgs.prek;
 }
 ```
 
@@ -77,7 +93,7 @@ Given the following `flake.nix` example:
           config = self.checks.${system}.pre-commit-check.config;
           inherit (config) package configFile;
           script = ''
-            ${package}/bin/pre-commit run --all-files --config ${configFile}
+            ${pkgs.lib.getExe package} run --all-files --config ${configFile}
           '';
         in
         pkgs.writeShellScriptBin "pre-commit-run" script
@@ -89,7 +105,7 @@ Given the following `flake.nix` example:
         pre-commit-check = inputs.git-hooks.lib.${system}.run {
           src = ./.;
           hooks = {
-            nixfmt-rfc-style.enable = true;
+            nixfmt.enable = true;
           };
         };
       });
@@ -359,6 +375,7 @@ use nix
 
 ### Markdown
 
+- [comrak](https://github.com/kivikakk/comrak)
 - [markdownlint](https://github.com/DavidAnson/markdownlint)
 - [mdformat](https://github.com/hukkin/mdformat)
 - [mdl](https://github.com/markdownlint/markdownlint/)
@@ -370,6 +387,7 @@ use nix
 - [deadnix](https://github.com/astro/deadnix)
 - [flake-checker](https://github.com/DeterminateSystems/flake-checker)
 - [nil](https://github.com/oxalica/nil)
+- [nixfmt](https://github.com/NixOS/nixfmt/) (supports `nixfmt` >=v1.0)
 - [nixfmt-classic](https://github.com/NixOS/nixfmt/tree/v0.6.0)
 - [nixfmt-rfc-style](https://github.com/NixOS/nixfmt/)
 - [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)
@@ -474,6 +492,7 @@ use nix
 
 - [actionlint](https://github.com/rhysd/actionlint)
 - [action-validator](https://github.com/mpalmer/action-validator)
+- [chart-testing](https://github.com/helm/chart-testing)
 - [check-added-large-files](https://github.com/pre-commit/pre-commit-hooks/blob/main/pre_commit_hooks/check_added_large_files.py)
 - [check-case-conflicts](https://github.com/pre-commit/pre-commit-hooks/blob/main/pre_commit_hooks/check_case_conflict.py)
 - [check-executables-have-shebangs](https://github.com/pre-commit/pre-commit-hooks/blob/main/pre_commit_hooks/check_executables_have_shebangs.py)
@@ -489,6 +508,8 @@ use nix
 - [end-of-file-fixer](https://github.com/pre-commit/pre-commit-hooks/blob/main/pre_commit_hooks/end_of_file_fixer.py)
 - [fix-byte-order-marker](https://github.com/pre-commit/pre-commit-hooks/blob/main/pre_commit_hooks/fix_byte_order_marker.py)
 - [headache](https://github.com/frama-c/headache)
+- [hledger-fmt](https://github.com/mondeja/hledger-fmt)
+- [keep-sorted](https://github.com/google/keep-sorted)
 - [mixed-line-endings](https://github.com/pre-commit/pre-commit-hooks/blob/main/pre_commit_hooks/mixed_line_ending.py)
 - [mkdocs-linkcheck](https://github.com/byrnereese/linkchecker-mkdocs)
 - [openapi-spec-validator](https://github.com/python-openapi/openapi-spec-validator)

flake-module.nix

@@ -37,7 +37,7 @@ in
                 Nixpkgs to use in the pre-commit [`settings`](#opt-perSystem.pre-commit.settings).
               '';
               default = pkgs;
-              defaultText = lib.literalMD "`pkgs` (module argument)";
+              defaultText = lib.literalExpression "`pkgs` (module argument)";
             };
             settings = mkOption {
               type = types.submoduleWith {
@@ -49,16 +49,23 @@ in
                 The git-hooks.nix configuration.
               '';
             };
+            shellHook = mkOption {
+              type = types.str;
+              description = "A shell hook that installs up the git hooks in a development shell.";
+              default = cfg.settings.installationScript;
+              defaultText = lib.literalExpression "bash statements";
+              readOnly = true;
+            };
             installationScript = mkOption {
               type = types.str;
-              description = "A bash fragment that sets up [pre-commit](https://pre-commit.com/).";
+              description = "A bash snippet that sets up the git hooks in the current repository.";
               default = cfg.settings.installationScript;
-              defaultText = lib.literalMD "bash statements";
+              defaultText = lib.literalExpression "bash statements";
               readOnly = true;
             };
             devShell = mkOption {
               type = types.package;
-              description = "A development shell with pre-commit installed and setup.";
+              description = "A development shell with the git hooks installed and all the packages made available.";
               readOnly = true;
             };
           };
@@ -72,8 +79,8 @@ in
             hooks.treefmt.package = lib.mkIf (options?treefmt) (lib.mkOverride 900 config.treefmt.build.wrapper);
           };
           pre-commit.devShell = pkgs.mkShell {
-            nativeBuildInputs = cfg.settings.enabledPackages ++ [ cfg.settings.package ];
-            shellHook = cfg.installationScript;
+            inherit (cfg.settings) shellHook;
+            nativeBuildInputs = cfg.settings.enabledPackages;
           };
         };
       });

flake.lock

@@ -57,7 +57,7 @@ in
     name = mkOption {
       type = types.str;
       default = name;
-      defaultText = lib.literalMD "the attribute name the hook submodule is bound to, same as `id`";
+      defaultText = lib.literalExpression "the attribute name the hook submodule is bound to, same as `id`";
       description =
         ''
           The name of the hook. Shown during hook execution.
@@ -186,7 +186,7 @@ in
         Confines the hook to run at a particular stage.
       '';
       default = default_stages;
-      defaultText = (lib.literalExpression or lib.literalExample) "default_stages";
+      defaultText = lib.literalExpression "default_stages";
     };
 
     verbose = mkOption {

modules/hook.nix

@@ -680,6 +680,20 @@ in
           };
         };
       };
+      hledger-fmt = mkOption {
+        description = "hledger-fmt hook";
+        type = types.submodule {
+          imports = [ hookModule ];
+          options.settings = {
+            fix =
+              mkOption {
+                type = types.bool;
+                description = "Fix the files in place.";
+                default = false;
+              };
+          };
+        };
+      };
       hlint = mkOption {
         description = "hlint hook";
         type = types.submodule {
@@ -959,7 +973,7 @@ in
         };
       };
       nixfmt = mkOption {
-        description = "Deprecated nixfmt hook. Use nixfmt-classic or nixfmt-rfc-style instead.";
+        description = "nixfmt hook";
         type = types.submodule {
           imports = [ hookModule ];
           options.settings = {
@@ -2154,10 +2168,19 @@ in
     lib.optional cfg.hooks.rome.enable ''
       The hook `hooks.rome` has been renamed to `hooks.biome`.
     ''
-    ++ lib.optional cfg.hooks.nixfmt.enable ''
+    ++ lib.optional (cfg.hooks.nixfmt.enable && lib.versionOlder cfg.hooks.nixfmt.package.version "1.0") ''
       The hook `hooks.nixfmt` has been renamed to `hooks.nixfmt-classic`.
 
       The new RFC 166-style nixfmt is available as `hooks.nixfmt-rfc-style`.
+    ''
+    ++ lib.optional (cfg.hooks.nixfmt-classic.enable && lib.versionAtLeast cfg.hooks.nixfmt-classic.package.version "1.0") ''
+      The hook `hooks.nixfmt-classic` is using an incompatible version of `nixfmt`.
+
+        Found: ${cfg.hooks.nixfmt-classic.package.version}.
+        Expected: < v1.0
+
+      `hooks.nixfmt-classic` supports versions of `nixfmt` up to `v1.0`.
+      For `nixfmt` `v1.0` and newer, switch to `hooks.nixfmt`.
     '';
 
   # PLEASE keep this sorted alphabetically.
@@ -2222,6 +2245,7 @@ in
             in
             "${hooks.ansible-lint.package}/bin/ansible-lint ${cmdArgs}";
           files = if hooks.ansible-lint.settings.subdir != "" then "${hooks.ansible-lint.settings.subdir}/" else "";
+          pass_filenames = false;
         };
       autoflake =
         {
@@ -2321,6 +2345,15 @@ in
           files = "\\.rs$";
           pass_filenames = false;
         };
+      chart-testing =
+        {
+          name = "chart-testing";
+          description = "CLI tool for linting and testing Helm charts";
+          files = "^charts/";
+          package = tools.chart-testing;
+          entry = "${hooks.chart-testing.package}/bin/ct lint --all --skip-helm-dependencies";
+          pass_filenames = false;
+        };
       checkmake = {
         name = "checkmake";
         description = "Experimental linter/analyzer for Makefiles";
@@ -2555,6 +2588,13 @@ in
           entry = "${hooks.commitizen.package}/bin/cz check --allow-abort --commit-msg-file";
           stages = [ "commit-msg" ];
         };
+      comrak = {
+        name = "comrak";
+        description = "A 100% CommonMark-compatible GitHub Flavored Markdown formatter";
+        package = tools.comrak;
+        entry = "${lib.getExe hooks.comrak.package} --inplace";
+        types = [ "markdown" ];
+      };
       conform = {
         name = "conform enforce";
         description = "Policy enforcement for commits.";
@@ -3086,6 +3126,22 @@ lib.escapeShellArgs (lib.concatMap (ext: [ "--ghc-opt" "-X${ext}" ]) hooks.fourm
           entry = "${hooks.hindent.package}/bin/hindent";
           files = "\\.l?hs(-boot)?$";
         };
+      hledger-fmt =
+        {
+          name = "hledger-fmt";
+          description = "Opinionated hledger's journal files formatter.";
+          package = tools.hledger-fmt;
+          entry =
+            let
+              cmdArgs = mkCmdArgs (
+                with hooks.hledger-fmt.settings; [
+                  [ fix "--fix" ]
+                ]
+              );
+            in
+            "${hooks.hledger-fmt.package}/bin/hledger-fmt ${cmdArgs}";
+          files = "\\.(hledger|journal|j)$";
+        };
       hlint =
         {
           name = "hlint";
@@ -3164,6 +3220,14 @@ lib.escapeShellArgs (lib.concatMap (ext: [ "--ghc-opt" "-X${ext}" ]) hooks.fourm
             end'
           '';
         };
+      keep-sorted =
+        {
+          name = "keep-sorted";
+          description = "Language-agnostic formatter that sorts lines between two markers in a larger file.";
+          types = [ "text" ];
+          package = tools.keep-sorted;
+          entry = "${hooks.keep-sorted.package}/bin/keep-sorted";
+        };
       latexindent =
         {
           name = "latexindent";
@@ -4161,7 +4225,7 @@ lib.escapeShellArgs (lib.concatMap (ext: [ "--ghc-opt" "-X${ext}" ]) hooks.fourm
               inherit (hooks.typos.settings) config exclude;
               configFile = toml.generate "typos-config.toml" config;
               excludeFlags = lib.concatStringsSep " "
-                (lib.map (glob: "--exclude ${glob}") exclude);
+                (lib.map (glob: "--exclude '${glob}'") exclude);
               cmdArgs =
                 mkCmdArgs
                   (with hooks.typos.settings; [
@@ -4310,7 +4374,7 @@ lib.escapeShellArgs (lib.concatMap (ext: [ "--ghc-opt" "-X${ext}" ]) hooks.fourm
               cmdArgs =
                 mkCmdArgs
                   (with hooks.yamllint.settings; [
-                    # Priorize multiline configuration over serialized configuration and configuration file
+                    # Prioritize multiline configuration over serialized configuration and configuration file
                     [ (configuration != "") "--config-file ${configFile}" ]
                     [ (configData != "" && configuration == "") "--config-data \"${configData}\"" ]
                     [ (configPath != "" && configData == "" && configuration == "" && preset == "default") "--config-file ${configPath}" ]