refactor(rust): update the way the rust.srcToolchain default works and also some defaultText

.rumdl.toml

@@ -0,0 +1,8 @@
+[global]
+disable = [
+  # line length limits
+  "MD013",
+]
+
+[MD057]
+absolute-links = "relative_to_roots"

cad/default.nix

@@ -155,8 +155,8 @@
           };
 
           # Formatter for nix files, available through 'nix fmt'
-          treefmt = lib.mkIf cfg.formatter.enable {
-            programs.alejandra.enable = lib.mkIf cfg.formatter.nix true;
+          treefmt.programs = lib.mkIf cfg.formatter.enable {
+            alejandra.enable = lib.mkIf cfg.formatter.nix true;
           };
         };
       });

flake.nix

@@ -36,6 +36,7 @@
         ./rust
         ./rust-esp32-c6
 
+        inputs.treefmt-nix.flakeModule
         flake-parts.flakeModules.flakeModules
         # define the flake.templates option
         ({lib, ...}: {
@@ -57,6 +58,13 @@
 
       systems = ["aarch64-linux" "x86_64-linux" "aarch64-darwin"];
 
-      perSystem = {pkgs, ...}: {formatter = pkgs.alejandra;};
+      perSystem = {pkgs, ...}: {
+        treefmt.programs = {
+          alejandra.enable = true; # nix
+          taplo.enable = true; # toml
+          rumdl-check.enable = true; # markdown
+          rumdl-format.enable = true; # markdown
+        };
+      };
     };
 }

rust-esp32-c6/default.nix

@@ -37,6 +37,14 @@
           krantz.rust.devDeps = lib.mkOptionDefault (with pkgs; [
             espflash
           ]);
+
+          krantz.rust.cargoArtifacts.extraAttrs = lib.mkOptionDefault {
+            doCheck = false;
+          };
+
+          krantz.rust.package.extraAttrs = lib.mkOptionDefault {
+            doCheck = false;
+          };
         };
       });
     };

rust-esp32-c6/template/.cargo/config.toml

@@ -8,7 +8,8 @@ DEFMT_LOG="info"
 rustflags = [
   # Required to obtain backtraces (e.g. when using the "esp-backtrace" crate.)
   # NOTE: May negatively impact performance of produced code
-  "-C", "force-frame-pointers",
+  "-C",
+  "force-frame-pointers",
 ]
 
 target = "riscv32imac-unknown-none-elf"

rust-esp32-c6/template/.rumdl.toml

@@ -0,0 +1,8 @@
+[global]
+disable = [
+  # line length limits
+  "MD013",
+]
+
+[MD057]
+absolute-links = "relative_to_roots"

rust/default.nix

@@ -29,7 +29,7 @@
         manifest = (lib.importTOML "${src}/Cargo.toml").package;
 
         craneLib =
-          if builtins.pathExists cfg.srcToolchain
+          if cfg.srcToolchain != null && builtins.pathExists cfg.srcToolchain
           then
             (inputs.crane.mkLib (pkgs.extend inputs.rust-overlay.overlays.default)).overrideToolchain (
               p: p.rust-bin.fromRustupToolchainFile cfg.srcToolchain
@@ -43,9 +43,10 @@
 
         # Build *just* the cargo dependencies, so we can reuse
         # all of that work (e.g. via cachix) when running in CI
-        cargoArtifacts = craneLib.buildDepsOnly {
+        cargoArtifacts = craneLib.buildDepsOnly ({
             inherit src buildInputs nativeBuildInputs;
-        };
+          }
+          // cfg.cargoArtifacts.extraAttrs);
       in {
         options.krantz.rust = {
           enable = lib.mkEnableOption "building a cargo project with crane";
@@ -60,14 +61,26 @@
             description = "A path to the filtered directory of the root of the crate.";
             type = lib.types.path;
             default = craneLib.cleanCargoSource cfg.src;
-            defaultText = lib.literalExpression "config.krantz.rust.craneLib cfg.src";
+            defaultText = lib.literalExpression "config.krantz.rust.craneLib.cleanCargoSource cfg.src";
             example = lib.literalExpression "./.";
           };
           srcToolchain = lib.mkOption {
             description = "A path to the rust-toolchain(.toml) file for the repo. Will use the toolchain from nixpkgs if the file does not exist.";
-            type = lib.types.path;
-            default = "${if cfg.src != null then cfg.src else "/dev/null"}/rust-toolchain.toml";
-            defaultText = lib.literalExpression "cfg.src + \"/rust-toolchain.toml\"";
+            type = lib.types.nullOr lib.types.path;
+            default =
+              if cfg.src != null
+              then cfg.src + "/rust-toolchain.toml"
+              else null;
+            defaultText =
+              lib.literalExpression
+              /*
+              nix
+              */
+              ''
+                if cfg.src != null
+                then cfg.src + "/rust-toolchain.toml"
+                else null;
+              '';
             example = lib.literalExpression "./rust-toolchain";
           };
 
@@ -96,6 +109,17 @@
             ];
           };
 
+          cargoArtifacts = {
+            extraAttrs = lib.mkOption {
+              description = "Extra attributes to merge into buildDepsOnly. See https://crane.dev/API.html#cranelibbuilddepsonly";
+              type = lib.types.attrs;
+              default = {};
+              example = {
+                doCheck = false;
+              };
+            };
+          };
+
           devShell = {
             enable = lib.mkEnableOption "a rust development environment" // {default = true;};
 
@@ -143,6 +167,8 @@
 
             nix = lib.mkEnableOption "formatting for nix files" // {default = true;};
             rust = lib.mkEnableOption "formatting for rust files" // {default = true;};
+            toml = lib.mkEnableOption "formatting for toml files" // {default = true;};
+            markdown = lib.mkEnableOption "formatting for toml files" // {default = true;};
           };
 
           checks = {
@@ -179,20 +205,22 @@
           # Your custom packages
           # Accessible through 'nix build', 'nix shell', 'nix run', etc
           packages = lib.mkIf cfg.package.enable {
-            ${cfg.package.name} =
-              craneLib.buildPackage {
+            ${cfg.package.name} = craneLib.buildPackage ({
                 inherit src buildInputs nativeBuildInputs cargoArtifacts;
               }
-              // cfg.package.extraAttrs;
+              // cfg.package.extraAttrs);
           };
 
           # Formatter for nix files, available through 'nix fmt'
-          treefmt = lib.mkIf cfg.formatter.enable {
-            programs.alejandra.enable = lib.mkIf cfg.formatter.nix true;
-            programs.rustfmt = lib.mkIf cfg.formatter.rust {
+          treefmt.programs = lib.mkIf cfg.formatter.enable {
+            alejandra.enable = lib.mkIf cfg.formatter.nix true;
+            rustfmt = lib.mkIf cfg.formatter.rust {
               enable = true;
               edition = manifest.edition;
             };
+            taplo.enable = lib.mkIf cfg.formatter.toml true;
+            rumdl-check.enable = lib.mkIf cfg.formatter.markdown true;
+            rumdl-format.enable = lib.mkIf cfg.formatter.markdown true;
           };
 
           checks = lib.mkIf cfg.checks.enable {

rust/template/.rumdl.toml

@@ -0,0 +1,8 @@
+[global]
+disable = [
+  # line length limits
+  "MD013",
+]
+
+[MD057]
+absolute-links = "relative_to_roots"

rust/template/Cargo.toml

@@ -15,4 +15,3 @@ tracing-subscriber = "*"
 
 clap = { version = "*", features = ["derive"] }
 figment = { version = "*", features = ["toml", "env", "json"] }
-