From a7b3b2584a7b9f204f634714fe9fbe3a3965b06c Mon Sep 17 00:00:00 2001
From: Wolfgang Walther <walther@technowledgy.de>
Date: Tue, 22 Jul 2025 16:12:42 +0200
Subject: [PATCH] ci/treefmt: add markdown-code-runner

This was run as a test in `doc/tests/check-nix-code-blocks.nix` before,
but its DX can be improved: By including it in `treefmt` we get better
error reporting and auto-fixing, as well as running it on *all* markdown
files (including READMEs etc.) for free.
---
 ci/default.nix                      | 17 +++++++++++++++
 doc/doc-support/package.nix         |  1 -
 doc/tests/check-nix-code-blocks.nix | 32 -----------------------------
 doc/tests/mdcr-config.toml          |  3 ---
 4 files changed, 17 insertions(+), 36 deletions(-)
 delete mode 100644 doc/tests/check-nix-code-blocks.nix
 delete mode 100644 doc/tests/mdcr-config.toml

diff --git a/ci/default.nix b/ci/default.nix
index eaa1879c34b4..727e591a90b8 100644
--- a/ci/default.nix
+++ b/ci/default.nix
@@ -75,6 +75,23 @@ let
           includes = [ "*" ];
           priority = 1;
         };
+
+        # TODO: Upstream this into treefmt-nix eventually:
+        #   https://github.com/numtide/treefmt-nix/issues/387
+        settings.formatter.markdown-code-runner = {
+          command = pkgs.lib.getExe pkgs.markdown-code-runner;
+          options =
+            let
+              config = pkgs.writers.writeTOML "markdown-code-runner-config" {
+                presets.nixfmt = {
+                  language = "nix";
+                  command = [ (pkgs.lib.getExe pkgs.nixfmt) ];
+                };
+              };
+            in
+            [ "--config=${config}" ];
+          includes = [ "*.md" ];
+        };
       };
       fs = pkgs.lib.fileset;
       nixFilesSrc = fs.toSource {
diff --git a/doc/doc-support/package.nix b/doc/doc-support/package.nix
index aefc301ec81c..8ed6865a1c90 100644
--- a/doc/doc-support/package.nix
+++ b/doc/doc-support/package.nix
@@ -137,7 +137,6 @@ stdenvNoCC.mkDerivation (
 
       tests = {
         manpage-urls = callPackage ../tests/manpage-urls.nix { };
-        check-nix-code-blocks = callPackage ../tests/check-nix-code-blocks.nix { };
       };
     };
   }
diff --git a/doc/tests/check-nix-code-blocks.nix b/doc/tests/check-nix-code-blocks.nix
deleted file mode 100644
index 5ec934f6bba8..000000000000
--- a/doc/tests/check-nix-code-blocks.nix
+++ /dev/null
@@ -1,32 +0,0 @@
-{
-  runCommand,
-  markdown-code-runner,
-  nixfmt-rfc-style,
-}:
-
-runCommand "manual_check-nix-code-blocks"
-  {
-    nativeBuildInputs = [
-      markdown-code-runner
-      nixfmt-rfc-style
-    ];
-  }
-  ''
-    set +e
-
-    mdcr --check --config ${./mdcr-config.toml} ${./..}
-
-    if [ $? -ne 0 ]; then
-      cat <<EOF
-    Error: `mdcr` command failed. Please make sure the Nix code snippets in Markdown files are correctly formatted.
-
-    Run this command from the Nixpkgs repository root for automatic formatting:
-
-        mdcr --log debug --config ${toString ./..}/tests/mdcr-config.toml ${toString ./..}
-
-    EOF
-      exit 1
-    fi
-
-    touch "$out"
-  ''
diff --git a/doc/tests/mdcr-config.toml b/doc/tests/mdcr-config.toml
deleted file mode 100644
index 489049f648f0..000000000000
--- a/doc/tests/mdcr-config.toml
+++ /dev/null
@@ -1,3 +0,0 @@
-[presets.nixfmt]
-language = "nix"
-command = ["nixfmt"]