feat(wrapperModules.quickshell): init (#544)

Author: ormoyo

wrapperModules/q/quickshell/check.nix

@@ -0,0 +1,105 @@
+{
+  pkgs,
+  self,
+  tlib,
+  ...
+}:
+let
+  inherit (tlib)
+    isDirectory
+    isFile
+    test
+    ;
+in
+test { wrapper = "quickshell"; } {
+  "wrapper should output correct version" =
+    let
+      wrapper = self.wrappers.quickshell.wrap {
+        inherit pkgs;
+      };
+    in
+    ''
+      "${wrapper}/bin/quickshell" --version |
+      grep -q "${wrapper.version}"
+    '';
+
+  "wrapper should create config dir" =
+    let
+      wrapper = self.wrappers.quickshell.wrap {
+        inherit pkgs;
+      };
+    in
+    isDirectory "${wrapper}/${wrapper.passthru.configuration.binName}-config";
+
+  "file tests" =
+    let
+      baseWrapper = self.wrappers.quickshell.apply {
+        inherit pkgs;
+
+        env.LANG = "C.utf8";
+        env.LC_ALL = "C.utf8";
+        env.XDG_RUNTIME_DIR = "/tmp";
+      };
+
+      shellContent = ''
+        Scope {
+          Bar {}
+        }
+      '';
+      barContent = ''
+        import Quickshell // for PanelWindow
+        import QtQuick // for Text
+
+        PanelWindow {
+          anchors {
+            top: true
+            left: true
+            right: true
+          }
+
+          implicitHeight: 30
+
+          Text {
+            anchors.centerIn: parent
+            text: "hello world"
+          }
+        }
+      '';
+
+      isShellPresent =
+        wrapper: isFile "${wrapper}/${wrapper.passthru.configuration.binName}-config/shell.qml";
+      isBarPresent =
+        wrapper: isFile "${wrapper}/${wrapper.passthru.configuration.binName}-config/Bar.qml";
+      isCorrectConfig = wrapper: ''
+        logs=$("${wrapper}/bin/quickshell" 2>&1)
+        echo "$logs" | grep -q "Launching config: \"${wrapper}/${wrapper.passthru.configuration.binName}-config/shell.qml\""
+      '';
+    in
+    {
+      "wrapper should load shell.qml and components" =
+        let
+          wrapper = baseWrapper.wrap {
+            configFile = shellContent;
+            components.bar = barContent;
+          };
+        in
+        [
+          (isShellPresent wrapper)
+          (isBarPresent wrapper)
+          (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;
+          };
+        in
+        [
+          (isShellPresent wrapper)
+          (isBarPresent wrapper)
+          (isCorrectConfig wrapper)
+        ];
+    };
+}

wrapperModules/q/quickshell/module.nix

@@ -0,0 +1,88 @@
+{
+  config,
+  lib,
+  wlib,
+  pkgs,
+  ...
+}:
+let
+  inherit (lib)
+    mapAttrs'
+    mkDefault
+    mkIf
+    mkOption
+    types
+    ;
+
+  isLinkable = wlib.types.linkable.check;
+  makeForce = lib.mkOverride 0;
+in
+{
+  imports = [ wlib.modules.default ];
+  options = {
+    configFile = mkOption {
+      type = types.either wlib.types.linkable types.lines;
+      default = "";
+      description = ''
+        The quickshell shell.qml configuration file.
+
+        Provide either inlined configuration or reference an external file.
+        It is used by quickshell using `--path`.
+      '';
+    };
+    components = mkOption {
+      type = types.attrsOf (types.either wlib.types.linkable types.lines);
+      default = { };
+      description = "Quickshell components to include in the configuration";
+    };
+    generated.output = mkOption {
+      type = types.str;
+      default = config.outputName;
+      description = "The constructed file's output";
+    };
+    generated.placeholder = mkOption {
+      type = types.str;
+      readOnly = true;
+      default = "${placeholder config.generated.output}/${config.binName}-config";
+      description = "A placeholder for the generated config dir";
+    };
+  };
+
+  config.package = mkDefault pkgs.quickshell;
+  config.flags."--path" = config.generated.placeholder;
+
+  config.passthru.generatedConfigDir = "${
+    config.wrapper.${config.generated.output}
+  }/${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
+    // {
+      generatedConfig = {
+        content = mkIf (!isLinkable config.configFile) config.configFile;
+        builder = mkIf (isLinkable config.configFile) ''ln -s ${config.configFile} "$2"'';
+        output = makeForce config.generated.output;
+        relPath = makeForce "${config.binName}-config/shell.qml";
+      };
+    };
+
+  config.meta.maintainers = [ wlib.maintainers.ormoyo ];
+  config.meta.platforms = lib.platforms.linux;
+}