feat(wrapperModules.quickshell): add option to set component's module

Author: ormoyo

wrapperModules/q/quickshell/check.nix

@@ -69,7 +69,10 @@ test { wrapper = "quickshell"; } {
       isShellPresent =
         wrapper: isFile "${wrapper}/${wrapper.passthru.configuration.binName}-config/shell.qml";
       isBarPresent =
-        wrapper: isFile "${wrapper}/${wrapper.passthru.configuration.binName}-config/Bar.qml";
+        wrapper: mod:
+        isFile "${wrapper}/${wrapper.passthru.configuration.binName}-config/${
+          if mod != null then "${mod}/" else ""
+        }Bar.qml";
       isCorrectConfig = wrapper: ''
         logs=$("${wrapper}/bin/quickshell" 2>&1)
         echo "$logs" | grep -q "Launching config: \"${wrapper}/${wrapper.passthru.configuration.binName}-config/shell.qml\""
@@ -85,20 +88,37 @@ test { wrapper = "quickshell"; } {
         in
         [
           (isShellPresent wrapper)
-          (isBarPresent wrapper)
+          (isBarPresent wrapper null)
           (isCorrectConfig wrapper)
         ];
 
       "wrapper should load external files" =
         let
           wrapper = baseWrapper.wrap {
             configFile = pkgs.writeText "quickshell-test-shell.qml" shellContent;
-            components.bar = pkgs.writeText "quickshell-test-bar.qml" barContent;
+            components.bar.data = pkgs.writeText "quickshell-test-bar.qml" barContent;
+            components.bar.name = "Bar.qml";
           };
         in
         [
           (isShellPresent wrapper)
-          (isBarPresent wrapper)
+          (isBarPresent wrapper null)
+          (isCorrectConfig wrapper)
+        ];
+
+      "wrapper should keep correct hierachy with component modules" =
+        let
+          wrapper = baseWrapper.wrap {
+            configFile = "import qs.foo.boo\n" + shellContent;
+            components.bar = {
+              data = barContent;
+              module = "foo.boo";
+            };
+          };
+        in
+        [
+          (isShellPresent wrapper)
+          (isBarPresent wrapper "foo/boo")
           (isCorrectConfig wrapper)
         ];
     };

wrapperModules/q/quickshell/module.nix

@@ -16,6 +16,35 @@ let
 
   isLinkable = wlib.types.linkable.check;
   makeForce = lib.mkOverride 0;
+
+  componentModule =
+    { name, config, ... }:
+    {
+      options = {
+        name = mkOption {
+          type = types.str;
+          default =
+            let
+              firstChar = builtins.substring 0 1 name;
+              rest = builtins.substring 1 (-1) name;
+            in
+            if (isLinkable config.data) then
+              (builtins.baseNameOf config.data)
+            else
+              (lib.toUpper firstChar) + rest + ".qml";
+          description = "The name of this component (either filename or directory name)";
+        };
+        data = mkOption {
+          type = types.either wlib.types.linkable types.lines;
+          description = "The component's inlined text or path";
+        };
+        module = mkOption {
+          type = types.nullOr types.str;
+          default = null;
+          description = "The component's module, to be imported by `import qs.<module>`";
+        };
+      };
+    };
 in
 {
   imports = [ wlib.modules.default ];
@@ -31,7 +60,7 @@ in
       '';
     };
     components = mkOption {
-      type = types.attrsOf (types.either wlib.types.linkable types.lines);
+      type = types.attrsOf (wlib.types.spec componentModule);
       default = { };
       description = "Quickshell components to include in the configuration";
     };
@@ -56,24 +85,17 @@ in
   }/${config.binName}-config";
 
   config.constructFiles =
-    mapAttrs' (
-      name: val:
-      let
-        firstChar = builtins.substring 0 1 name;
-        rest = builtins.substring 1 (-1) name;
-        capitalizedName = (lib.toUpper firstChar) + rest;
-        linkable = isLinkable val;
-      in
-      {
-        name = "${name}Component";
-        value = {
-          content = mkIf (!linkable) val;
-          builder = mkIf linkable ''ln -s ${val} "$2"'';
-          output = makeForce config.generated.output;
-          relPath = makeForce "${config.binName}-config/${capitalizedName}.qml";
-        };
-      }
-    ) config.components
+    mapAttrs' (name: val: {
+      name = "${name}Component";
+      value = {
+        content = mkIf (!isLinkable val.data) val.data;
+        builder = mkIf (isLinkable val.data) ''ln -s ${val.data} "$2"'';
+        output = makeForce config.generated.output;
+        relPath = makeForce "${config.binName}-config/${
+          if val.module != null then "${lib.replaceString "." "/" val.module}/" else ""
+        }${val.name}";
+      };
+    }) config.components
     // {
       generatedConfig = {
         content = mkIf (!isLinkable config.configFile) config.configFile;