From bcbeccfa7d3fff2203ddfd4a2e4b8ba0f1f38584 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlys=20Bras=20de=20fer?= Date: Wed, 22 May 2024 19:14:29 +0200 Subject: [PATCH] nixos/{sway,river,hyprland}: cleanup --- nixos/modules/programs/wayland/hyprland.nix | 43 +++++---- nixos/modules/programs/wayland/river.nix | 12 +-- nixos/modules/programs/wayland/sway.nix | 98 +++++++-------------- 3 files changed, 59 insertions(+), 94 deletions(-) diff --git a/nixos/modules/programs/wayland/hyprland.nix b/nixos/modules/programs/wayland/hyprland.nix index 89e0159779d9..7176cfbbc2d2 100644 --- a/nixos/modules/programs/wayland/hyprland.nix +++ b/nixos/modules/programs/wayland/hyprland.nix @@ -2,23 +2,14 @@ let cfg = config.programs.hyprland; - - finalPortalPackage = cfg.portalPackage.override { - hyprland = cfg.finalPackage; - }; in { options.programs.hyprland = { - enable = lib.mkEnableOption null // { - description = '' - Whether to enable Hyprland, the dynamic tiling Wayland compositor that doesn't sacrifice on its looks. - - You can manually launch Hyprland by executing {command}`Hyprland` on a TTY. - - A configuration file will be generated in {file}`~/.config/hypr/hyprland.conf`. - See for more information. - ''; - }; + enable = lib.mkEnableOption '' + Hyprland, the dynamic tiling Wayland compositor that doesn't sacrifice on its looks. + You can manually launch Hyprland by executing {command}`Hyprland` on a TTY. + A configuration file will be generated in {file}`~/.config/hypr/hyprland.conf`. + See for more information''; package = lib.mkPackageOption pkgs "hyprland" { }; @@ -28,8 +19,9 @@ in default = cfg.package.override { enableXWayland = cfg.xwayland.enable; }; - defaultText = lib.literalExpression - "`programs.hyprland.package` with applied configuration"; + defaultText = lib.literalMD '' + `programs.hyprland.package` with applied configuration + ''; description = '' The Hyprland package after applying configuration. ''; @@ -37,7 +29,21 @@ in portalPackage = lib.mkPackageOption pkgs "xdg-desktop-portal-hyprland" { }; - xwayland.enable = lib.mkEnableOption ("XWayland") // { default = true; }; + finalPortalPackage = lib.mkOption { + type = lib.types.package; + readOnly = true; + default = cfg.portalPackage.override { + hyprland = cfg.finalPackage; + }; + defaultText = lib.literalMD '' + `programs.hyprland.portalPackage` with applied configuration + ''; + description = '' + The Hyprland Portal package after applying configuration. + ''; + }; + + xwayland.enable = lib.mkEnableOption "XWayland" // { default = true; }; systemd.setPath.enable = lib.mkEnableOption null // { default = true; @@ -54,10 +60,11 @@ in { environment.systemPackages = [ cfg.finalPackage ]; + # To make a Hyprland session available if a display manager like SDDM is enabled: services.displayManager.sessionPackages = [ cfg.finalPackage ]; xdg.portal = { - extraPortals = [ finalPortalPackage ]; + extraPortals = [ cfg.finalPortalPackage ]; configPackages = lib.mkDefault [ cfg.finalPackage ]; }; diff --git a/nixos/modules/programs/wayland/river.nix b/nixos/modules/programs/wayland/river.nix index b83f13e2650e..ef8fbbd3489b 100644 --- a/nixos/modules/programs/wayland/river.nix +++ b/nixos/modules/programs/wayland/river.nix @@ -22,18 +22,12 @@ in extraPackages = lib.mkOption { type = with lib.types; listOf package; - default = with pkgs; [ - swaylock - foot - dmenu - ]; + default = with pkgs; [ swaylock foot dmenu ]; defaultText = lib.literalExpression '' with pkgs; [ swaylock foot dmenu ]; ''; example = lib.literalExpression '' - with pkgs; [ - termite rofi light - ] + with pkgs; [ termite rofi light ] ''; description = '' Extra packages to be installed system wide. See @@ -48,7 +42,7 @@ in environment.systemPackages = lib.optional (cfg.package != null) cfg.package ++ cfg.extraPackages; # To make a river session available if a display manager like SDDM is enabled: - services.displayManager.sessionPackages = lib.optionals (cfg.package != null) [ cfg.package ]; + services.displayManager.sessionPackages = lib.optional (cfg.package != null) cfg.package; # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1050913 xdg.portal.config.river.default = lib.mkDefault [ "wlr" "gtk" ]; diff --git a/nixos/modules/programs/wayland/sway.nix b/nixos/modules/programs/wayland/sway.nix index b001b74c24a4..20c4ea648479 100644 --- a/nixos/modules/programs/wayland/sway.nix +++ b/nixos/modules/programs/wayland/sway.nix @@ -3,44 +3,9 @@ let cfg = config.programs.sway; - wrapperOptions = lib.types.submodule { - options = - let - mkWrapperFeature = default: description: lib.mkOption { - type = lib.types.bool; - inherit default; - example = !default; - description = "Whether to make use of the ${description}"; - }; - in { - base = mkWrapperFeature true '' - base wrapper to execute extra session commands and prepend a - dbus-run-session to the sway command. - ''; - gtk = mkWrapperFeature false '' - wrapGAppsHook wrapper to execute sway with required environment - variables for GTK applications. - ''; - }; - }; - genFinalPackage = pkg: let - expectedArgs = lib.naturalSort [ - "extraSessionCommands" - "extraOptions" - "withBaseWrapper" - "withGtkWrapper" - "enableXWayland" - "isNixOS" - ]; - existedArgs = with lib; - naturalSort - (intersectLists expectedArgs (attrNames (functionArgs pkg.override))); - in if existedArgs != expectedArgs then - pkg - else - pkg.override { + args = { extraSessionCommands = cfg.extraSessionCommands; extraOptions = cfg.extraOptions; withBaseWrapper = cfg.wrapperFeatures.base; @@ -48,6 +13,13 @@ let enableXWayland = cfg.xwayland.enable; isNixOS = true; }; + + expectedArgs = with lib; + lib.naturalSort (lib.attrNames args); + existingArgs = with lib; + naturalSort (intersectLists expectedArgs (attrNames (functionArgs pkg.override))); + in + if existingArgs != expectedArgs then pkg else pkg.override args; in { options.programs.sway = { @@ -58,30 +30,28 @@ in and "man 5 sway" for more information''; - package = lib.mkOption { - type = with lib.types; nullOr package; - default = pkgs.sway; - apply = p: if p == null then null else genFinalPackage p; - defaultText = lib.literalExpression "pkgs.sway"; - description = '' - Sway package to use. If the package does not contain the override arguments - `extraSessionCommands`, `extraOptions`, `withBaseWrapper`, `withGtkWrapper`, - `enableXWayland` and `isNixOS`, then the module options {option}`wrapperFeatures`, - {option}`extraSessionCommands`, {option}`extraOptions` and {option}`wayland` - will have no effect. + package = lib.mkPackageOption pkgs "sway" { + nullable = true; + extraDescription = '' + If the package is not overridable with `extraSessionCommands`, `extraOptions`, + `withBaseWrapper`, `withGtkWrapper`, `enableXWayland` and `isNixOS`, + then the module options {option}`wrapperFeatures`, {option}`extraSessionCommands`, + {option}`extraOptions` and {option}`xwayland` will have no effect. - Set to `null` to not add any Sway package to your path. This should be done if - you want to use the Home Manager Sway module to install Sway. + Set to `null` to not add any Sway package to your path. + This should be done if you want to use the Home Manager Sway module to install Sway. ''; + } // { + apply = p: if p == null then null else genFinalPackage p; }; - wrapperFeatures = lib.mkOption { - type = wrapperOptions; - default = { }; - example = { gtk = true; }; - description = '' - Attribute set of features to enable in the wrapper. - ''; + wrapperFeatures = { + base = lib.mkEnableOption '' + the base wrapper to execute extra session commands and prepend a + dbus-run-session to the sway command'' // { default = true; }; + gtk = lib.mkEnableOption '' + the wrapGAppsHook wrapper to execute sway with required environment + variables for GTK applications''; }; extraSessionCommands = lib.mkOption { @@ -123,17 +93,12 @@ in extraPackages = lib.mkOption { type = with lib.types; listOf package; - default = with pkgs; [ - swaylock swayidle foot dmenu wmenu - ]; + default = with pkgs; [ swaylock swayidle foot dmenu wmenu ]; defaultText = lib.literalExpression '' with pkgs; [ swaylock swayidle foot dmenu wmenu ]; ''; example = lib.literalExpression '' - with pkgs; [ - i3status i3status-rust - termite rofi light - ] + with pkgs; [ i3status i3status-rust termite rofi light ] ''; description = '' Extra packages to be installed system wide. See @@ -150,8 +115,7 @@ in { assertion = cfg.extraSessionCommands != "" -> cfg.wrapperFeatures.base; message = '' - The extraSessionCommands for Sway will not be run if - wrapperFeatures.base is disabled. + The extraSessionCommands for Sway will not be run if wrapperFeatures.base is disabled. ''; } ]; @@ -160,7 +124,7 @@ in systemPackages = lib.optional (cfg.package != null) cfg.package ++ cfg.extraPackages; # Needed for the default wallpaper: - pathsToLink = lib.optionals (cfg.package != null) [ "/share/backgrounds/sway" ]; + pathsToLink = lib.optional (cfg.package != null) "/share/backgrounds/sway"; etc = { "sway/config.d/nixos.conf".source = pkgs.writeText "nixos.conf" '' @@ -176,7 +140,7 @@ in programs.gnupg.agent.pinentryPackage = lib.mkDefault pkgs.pinentry-gnome3; # To make a Sway session available if a display manager like SDDM is enabled: - services.displayManager.sessionPackages = lib.optionals (cfg.package != null) [ cfg.package ]; + services.displayManager.sessionPackages = lib.optional (cfg.package != null) cfg.package; # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1050913 xdg.portal.config.sway.default = lib.mkDefault [ "wlr" "gtk" ];