Migrating pre-commit-hooks from LB

Author: bladyjoker

.envrc

@@ -0,0 +1 @@
+use flake .#default

.gitignore

@@ -28,3 +28,4 @@ cabal.project.local
 cabal.project.local~
 .HTF/
 .ghc.environment.*
+.direnv/

examples/build.nix

@@ -5,6 +5,7 @@ _:
 {
   imports =
     [
+      ./pre-commit.nix
       ./haskell-flake-project/build.nix
       ./rust-flake-project/build.nix
       ./typescript-flake-project/build.nix

examples/pre-commit.nix

@@ -0,0 +1,15 @@
+{ inputs, config, ... }: {
+  imports = [
+    inputs.pre-commit-hooks.flakeModule
+    config.flake-lang.rustMonorepoPreCommit
+    config.flake-lang.denoPreCommit
+  ];
+  perSystem = _: {
+    pre-commit.settings = {
+      hooks = {
+        rust-monorepo.enable = true;
+        my-deno.enable = true;
+      };
+    };
+  };
+}

flake-lang/build.nix

@@ -1,5 +1,4 @@
-# Note(jaredponn): 
-
+# NOTE(jaredponn):
 # Loosely, the key idea is that in this flake we want to have an attribute like
 # ```
 # lib.<system> = {
@@ -10,7 +9,7 @@
 # };
 # ```
 # This is unfortunately not super easy to do with flake-parts! Some useful
-# links + examples are as follows. 
+# links + examples are as follows.
 # - [1] https://github.com/hercules-ci/flake-parts/blob/main/lib.nix
 # - [2] https://github.com/hercules-ci/flake-parts/pull/63/files
 # - [3] https://github.com/hercules-ci/flake-parts/blob/main/modules/formatter.nix
@@ -79,8 +78,23 @@
             default = import ./typescript/flake-typescript.nix pkgs;
             readOnly = true;
             description = lib.mdDoc builtins.readFile ./typescript/description.md;
-            # TODO(jaredponn): add an example
-            # example = lib.mdDoc '' '';
+            example = lib.mdDoc ''TODO(jaredponn)'';
+          };
+
+          rustMonorepoPreCommit = lib.mkOption {
+            type = lib.types.flakeModule;
+            default = ./pre-commit-hooks/rust-monorepo.nix;
+            readOnly = true;
+            description = lib.mdDoc ''pre-commit-hooks.nix hook for Rust in a monorepo setting'';
+            example = lib.mdDoc ''TODO(bladyjoker)'';
+          };
+
+          denoPreCommit = lib.mkOption {
+            type = lib.types.flakeModule;
+            default = ./pre-commit-hooks/deno.nix;
+            readOnly = true;
+            description = lib.mdDoc ''pre-commit-hooks.nix hook for Deno in a monorepo setting'';
+            example = lib.mdDoc ''TODO(bladyjoker)'';
           };
 
         };

flake-lang/pre-commit-hooks/deno.nix

@@ -0,0 +1,33 @@
+{ inputs, ... }: {
+  imports = [
+    inputs.pre-commit-hooks.flakeModule # Adds perSystem.pre-commit options
+    ./tools.nix
+  ];
+  perSystem = { config, ... }:
+    {
+      pre-commit.settings.hooks = {
+        # TODO(jaredponn): Why do we use our strange version of `denofmt` and
+        # `denolint`? The default implemented version in `pre-commit-hooks.nix`
+        # is a bit buggy (see
+        # https://github.com/cachix/pre-commit-hooks.nix/issues/374), and the
+        # latest version of `deno` on nix doesn't allow explicitly applying
+        # the formatter to specific files
+        my-denofmt =
+          {
+            name = "denofmt";
+            description = "Format Typescript code.";
+            entry = "${config.flake-lang.pre-commit-hooks.tools.deno}/bin/deno fmt";
+            files = "(\\.m?ts$)|(^tsconfig?(-base)\\.json$)";
+          };
+
+        my-denolint =
+          {
+            name = "denolint";
+            description = "Lint Typescript code.";
+            entry = "${config.flake-lang.pre-commit-hooks.tools.deno}/bin/deno lint";
+            files = "\\.m?ts$";
+          };
+
+      };
+    };
+}

flake-lang/pre-commit-hooks/rust-monorepo.nix

@@ -0,0 +1,19 @@
+{ inputs, ... }: {
+  imports = [
+    inputs.pre-commit-hooks.flakeModule # Adds perSystem.pre-commit options
+    ./tools.nix
+  ];
+  perSystem = { config, ... }:
+    {
+      pre-commit.settings.hooks = {
+        rustfmt-monorepo =
+          {
+            name = "rustfmt";
+            description = "Format Rust code.";
+            entry = "${config.flake-lang.pre-commit-hooks.tools.rustfmt}/bin/rustfmt --color always";
+            files = "\\.rs$";
+          };
+
+      };
+    };
+}

flake-lang/pre-commit-hooks/tools.nix

@@ -0,0 +1,23 @@
+{ flake-parts-lib, lib, ... }: {
+  perSystem = flake-parts-lib.mkPerSystemOption ({ pkgs, pkgsForRust, ... }: {
+    options = {
+      flake-lang.pre-commit-hooks.tools = {
+
+        rustfmt = lib.mkOption {
+          type = lib.types.derivation;
+          default = pkgsForRust.rustfmt;
+          readOnly = false;
+          description = lib.mdDoc ''Rust formatter to use for pre-commit hooks'';
+        };
+
+        deno = lib.mkOption {
+          type = lib.types.derivation;
+          default = pkgs.deno;
+          readOnly = false;
+          description = lib.mdDoc ''Deno tool to use for pre-commit hooks'';
+        };
+
+      };
+    };
+  });
+}

pre-commit.nix

@@ -1,7 +1,9 @@
 { inputs, ... }: {
-  imports = [ inputs.pre-commit-hooks.flakeModule ];
+  imports = [
+    inputs.pre-commit-hooks.flakeModule
+  ];
   perSystem = { config, ... }: {
-    devShells.dev-pre-commit = config.pre-commit.devShell;
+    devShells.default = config.pre-commit.devShell;
     pre-commit.settings = {
       hooks = {
         # Typos