From 9b61cc39b2c82f01b63bb0ae85865d7372697fc4 Mon Sep 17 00:00:00 2001
From: Alexey Lebedeff <binarin@binarin.info>
Date: Sun, 17 Nov 2024 17:40:52 +0100
Subject: [PATCH] stylix: don't split autoloaded modules into a separate
 derivation (#631)

Apparently `../modules` is creating a separate derivation that contains
only that folder, so it's now separate from the flake source. But this
transient derivation isn't mentioned explicitly anywhere in the flake
outputs. It makes it impossible to target those modules in
`disabledModules` directive.

For example, after this change is applied, users can solve issues like
https://github.com/danth/stylix/issues/577 locally, by just adding the
following snippet to their configuration:

    disabledModules = [ "${inputs.stylix}/modules/regreet/nixos.nix" ];

Reviewed-by: Daniel Thwaites <danthwaites30@btinternet.com>
Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
---
 docs/src/tricks.md        | 22 ++++++++++++++++++++++
 stylix/autoload.nix       |  6 +++---
 stylix/darwin/default.nix |  2 +-
 stylix/hm/default.nix     |  2 +-
 stylix/nixos/default.nix  |  2 +-
 stylix/testbed.nix        |  4 ++--
 6 files changed, 30 insertions(+), 8 deletions(-)

diff --git a/docs/src/tricks.md b/docs/src/tricks.md
index c25e3485..5fdda9fe 100644
--- a/docs/src/tricks.md
+++ b/docs/src/tricks.md
@@ -57,3 +57,25 @@ Which is neatly implemented as a single function in `lib.stylix.pixel`:
   };
 }
 ```
+
+## Completely disabling some stylix targets
+
+Nixpkgs module system sometimes works in non-intuitive ways, e.g. parts
+of the configuration guarded by `lib.mkIf` are still being descended
+into. This means that every **loaded** (and not enabled) module must
+be compatible with others - in the sense that **every** option that is
+mentioned in the disabled parts of the configuration still needs to be
+defined somewhere.
+
+Sometimes that can be a problem, when your particular configuration
+diverges enough from what stylix expects. In that case you can try
+stubbing all the missing options in your configuration.
+
+Or in a much clearer fashion you can just disable offending stylix targets
+by adding the following `disableModules` line next to importing stylix
+itself:
+
+```nix
+imports = [ flake.inputs.stylix.nixosModules.stylix ];
+disabledModules = [ "${flake.inputs.stylix}/modules/<some-module>/nixos.nix" ];
+```
diff --git a/stylix/autoload.nix b/stylix/autoload.nix
index bfb2fe68..8610ebca 100644
--- a/stylix/autoload.nix
+++ b/stylix/autoload.nix
@@ -1,4 +1,4 @@
-{ lib }:
+{ lib, inputs }:
 
 # string -> [ path ]
 # List include path for either nixos modules or hm modules
@@ -8,7 +8,7 @@ for:
       (path: kind:
         if kind == "directory"
           then let
-            file = "${../modules}/${path}/${for}.nix";
+            file = "${inputs.self}/modules/${path}/${for}.nix";
           in if builtins.pathExists file then [ file ] else [ ]
           else [ ])
-      (builtins.readDir ../modules))
+      (builtins.readDir "${inputs.self}/modules"))
diff --git a/stylix/darwin/default.nix b/stylix/darwin/default.nix
index 19e7c6e1..a4eca70c 100644
--- a/stylix/darwin/default.nix
+++ b/stylix/darwin/default.nix
@@ -3,7 +3,7 @@ inputs:
 { lib, ... }:
 
 let
-  autoload = import ../autoload.nix { inherit lib; } "darwin";
+  autoload = import ../autoload.nix { inherit lib inputs; } "darwin";
 in {
   imports = [
     ../pixel.nix
diff --git a/stylix/hm/default.nix b/stylix/hm/default.nix
index a5cae177..225ea275 100644
--- a/stylix/hm/default.nix
+++ b/stylix/hm/default.nix
@@ -3,7 +3,7 @@ inputs:
 { lib, ... }:
 
 let
-  autoload = import ../autoload.nix { inherit lib; } "hm";
+  autoload = import ../autoload.nix { inherit lib inputs; } "hm";
 in {
   imports = [
     ../pixel.nix
diff --git a/stylix/nixos/default.nix b/stylix/nixos/default.nix
index 56c4741b..eba04058 100644
--- a/stylix/nixos/default.nix
+++ b/stylix/nixos/default.nix
@@ -3,7 +3,7 @@ inputs:
 { lib, ... }:
 
 let
-  autoload = import ../autoload.nix { inherit lib; } "nixos";
+  autoload = import ../autoload.nix { inherit lib inputs; } "nixos";
 in {
   imports = [
     ../pixel.nix
diff --git a/stylix/testbed.nix b/stylix/testbed.nix
index cbfaffcb..c5b7c1ae 100644
--- a/stylix/testbed.nix
+++ b/stylix/testbed.nix
@@ -30,12 +30,12 @@ let
       (name: _:
         let testbed = {
           inherit name;
-          module = "${../modules}/${name}/testbed.nix";
+          module = "${inputs.self}/modules/${name}/testbed.nix";
         };
         in
           lib.optional (builtins.pathExists testbed.module) testbed
       )
-      (builtins.readDir ../modules));
+      (builtins.readDir "${inputs.self}/modules"));
 
   makeTestbed =
     testbed: stylix: