From 2f23155326713ad7420ae57c54eef05b5c0c2468 Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Mon, 24 Mar 2025 17:49:47 +0100 Subject: [PATCH 1/8] smug: init module This adds smug, a session manager and task runner for tmux, as module. --- modules/lib/maintainers.nix | 6 + modules/misc/news.nix | 9 ++ modules/modules.nix | 1 + modules/programs/smug.nix | 151 ++++++++++++++++++ tests/default.nix | 2 + tests/modules/programs/smug/blogdemo.yml | 33 ++++ tests/modules/programs/smug/default.nix | 4 + .../modules/programs/smug/empty-settings.nix | 6 + tests/modules/programs/smug/settings.nix | 54 +++++++ 9 files changed, 266 insertions(+) create mode 100644 modules/programs/smug.nix create mode 100644 tests/modules/programs/smug/blogdemo.yml create mode 100644 tests/modules/programs/smug/default.nix create mode 100644 tests/modules/programs/smug/empty-settings.nix create mode 100644 tests/modules/programs/smug/settings.nix diff --git a/modules/lib/maintainers.nix b/modules/lib/maintainers.nix index e6a43034f..efd76f28e 100644 --- a/modules/lib/maintainers.nix +++ b/modules/lib/maintainers.nix @@ -726,4 +726,10 @@ github = "Noodlez1232"; githubId = 12480453; }; + mipmip = { + name = "Pim Snel"; + email = "post@pimsnel.com"; + github = "mipmip"; + githubId = 658612; + }; } diff --git a/modules/misc/news.nix b/modules/misc/news.nix index cdff6d820..2dd40e93c 100644 --- a/modules/misc/news.nix +++ b/modules/misc/news.nix @@ -2157,6 +2157,15 @@ in { See https://github.com/WGUNDERWOOD/tex-fmt for more information. ''; } + { + time = "2025-03-24T15:29:33+00:00"; + message = '' + A new module is available: 'programs.smug'. + + Session manager and task runner for tmux written in Go. + See https://github.com/ivaaaan/smug for more information. + ''; + } ]; }; } diff --git a/modules/modules.nix b/modules/modules.nix index 68bdf73e3..4849769ee 100644 --- a/modules/modules.nix +++ b/modules/modules.nix @@ -239,6 +239,7 @@ let ./programs/sioyek.nix ./programs/skim.nix ./programs/sm64ex.nix + ./programs/smug.nix ./programs/spotify-player.nix ./programs/sqls.nix ./programs/ssh.nix diff --git a/modules/programs/smug.nix b/modules/programs/smug.nix new file mode 100644 index 000000000..6e04478ed --- /dev/null +++ b/modules/programs/smug.nix @@ -0,0 +1,151 @@ +{ config, lib, pkgs, ... }: + +let + cfg = config.programs.smug; + iniFormat = pkgs.formats.yaml { }; + + mkOptionCommands = description: + lib.mkOption { + type = lib.types.nullOr (lib.types.listOf lib.types.str); + default = null; + description = description; + }; + + mkOptionRoot = description: + lib.mkOption { + type = lib.types.nullOr lib.types.str; + default = null; + description = description; + }; + +in { + meta.maintainers = with lib.hm.maintainers; [ mipmip ]; + + options.programs.smug = { + + enable = lib.mkEnableOption "Smug session manager"; + + package = lib.mkOption { + type = lib.types.package; + default = pkgs.smug; + defaultText = lib.literalExpression "pkgs.smug"; + description = "Package providing {command}`smug`."; + }; + + projects = lib.mkOption { + type = lib.types.attrsOf (lib.types.submodule [{ + options = { + root = mkOptionRoot '' + Root path in filesystem of the smug project. This is where tmux + changes its directory to. Defaults to $HOME. + ''; + + windows = lib.mkOption { + type = lib.types.listOf (lib.types.submodule [{ + options = { + name = lib.mkOption { + type = lib.types.str; + description = '' + Name of the tmux window; + ''; + }; + + root = mkOptionRoot + "Root path of window. This is relative to the path of the smug project."; + + commands = + mkOptionCommands "Commands to execute when window starts."; + + layout = lib.mkOption { + type = lib.types.enum [ + "main-horizontal" + "main-vertical" + "even-vertical" + "even-horizontal" + "tiled" + ]; + description = '' + Layout of window when opening panes. + ''; + }; + + manual = lib.mkOption { + type = lib.types.nullOr lib.types.bool; + default = null; + description = '' + Start window only manually, using the -w arg + ''; + }; + + panes = lib.mkOption { + default = null; + description = '' + Panes to open in a window. + ''; + type = lib.types.nullOr (lib.types.listOf + (lib.types.submodule [{ + options = { + root = mkOptionRoot + "Root path of pane. This is relative to the path of the smug project."; + commands = mkOptionCommands + "Commands to execute when pane starts."; + type = lib.mkOption { + type = lib.types.enum [ "horizontal" "vertical" ]; + description = '' + Type of pane. + ''; + }; + + }; + }])); + }; + + }; + }]); + description = '' + Windows to create in the project session + ''; + }; + + env = lib.mkOption { + type = lib.types.nullOr (lib.types.attrsOf lib.types.str); + default = null; + description = "Environment Variables to set in session."; + }; + beforeStart = mkOptionCommands + "Commands to execute before the tmux-session starts."; + stop = mkOptionCommands + " Commands to execute after the tmux-session is destroyed."; + + }; + } + + ]); + default = { }; + description = "List of project configurations."; + }; + }; + + config = let + cleanedProjects = + lib.filterAttrsRecursive (name: value: value != null) cfg.projects; + + mkProjects = lib.attrsets.mapAttrs' (k: v: { + name = "${config.home.homeDirectory}/.config/smug/${k}.yml"; + value.source = let + prjConf = lib.attrsets.mapAttrs' (name: value: + (lib.attrsets.nameValuePair + (if name == "beforeStart" then "before_start" else name) (value))) v + // { + session = k; + windows = lib.lists.forEach v.windows (winprop: + (lib.filterAttrsRecursive (name: value: value != null) winprop)); + }; + in iniFormat.generate "smug-project-${k}" prjConf; + }); + + in lib.mkIf cfg.enable { + home.packages = [ cfg.package ]; + home.file = { } // (mkProjects cleanedProjects); + }; +} diff --git a/tests/default.nix b/tests/default.nix index 427f4e87a..a2deefc41 100644 --- a/tests/default.nix +++ b/tests/default.nix @@ -171,6 +171,7 @@ let "sioyek" "skhd" "sm64ex" + "smug" "spotify-player" "starship" "taskwarrior" @@ -386,6 +387,7 @@ in import nmtSrc { ./modules/programs/sftpman ./modules/programs/sioyek ./modules/programs/sm64ex + ./modules/programs/smug ./modules/programs/spotify-player ./modules/programs/ssh ./modules/programs/starship diff --git a/tests/modules/programs/smug/blogdemo.yml b/tests/modules/programs/smug/blogdemo.yml new file mode 100644 index 000000000..0cb5004ea --- /dev/null +++ b/tests/modules/programs/smug/blogdemo.yml @@ -0,0 +1,33 @@ +before_start: +- docker-compose -f my-microservices/docker-compose.yml up -d +env: + FOO: bar +root: ~/Developer/blog +session: blogdemo +stop: +- docker stop $(docker ps -q) +windows: +- commands: + - docker-compose start + layout: main-vertical + manual: true + name: code + panes: + - commands: + - docker-compose exec php /bin/sh + - clear + root: . + type: horizontal + root: blog +- commands: + - docker-compose start + layout: tiled + name: infrastructure + panes: + - commands: + - docker-compose up -d + - docker-compose exec php /bin/sh + - clear + root: . + type: horizontal + root: ~/Developer/blog/my-microservices diff --git a/tests/modules/programs/smug/default.nix b/tests/modules/programs/smug/default.nix new file mode 100644 index 000000000..0c959b6b6 --- /dev/null +++ b/tests/modules/programs/smug/default.nix @@ -0,0 +1,4 @@ +{ + smug-settings = ./settings.nix; + smug-empty-settings = ./empty-settings.nix; +} diff --git a/tests/modules/programs/smug/empty-settings.nix b/tests/modules/programs/smug/empty-settings.nix new file mode 100644 index 000000000..598463773 --- /dev/null +++ b/tests/modules/programs/smug/empty-settings.nix @@ -0,0 +1,6 @@ +{ + programs.smug.enable = true; + nmt.script = '' + assertPathNotExists home-files/.config/smug + ''; +} diff --git a/tests/modules/programs/smug/settings.nix b/tests/modules/programs/smug/settings.nix new file mode 100644 index 000000000..ec26d88b1 --- /dev/null +++ b/tests/modules/programs/smug/settings.nix @@ -0,0 +1,54 @@ +{ + programs = { + smug = { + enable = true; + + projects = { + + blogdemo = { + root = "~/Developer/blog"; + beforeStart = [ + "docker-compose -f my-microservices/docker-compose.yml up -d" # my-microservices/docker-compose.yml is a relative to `root`-al + ]; + env = { FOO = "bar"; }; + stop = [ "docker stop $(docker ps -q)" ]; + windows = [ + { + name = "code"; + root = "blog"; + manual = true; + layout = "main-vertical"; + commands = [ "docker-compose start" ]; + panes = [{ + type = "horizontal"; + root = "."; + commands = [ "docker-compose exec php /bin/sh" "clear" ]; + }]; + } + + { + name = "infrastructure"; + root = "~/Developer/blog/my-microservices"; + layout = "tiled"; + commands = [ "docker-compose start" ]; + panes = [{ + type = "horizontal"; + root = "."; + commands = [ + "docker-compose up -d" + "docker-compose exec php /bin/sh" + "clear" + ]; + }]; + } + ]; + }; + + }; + }; + }; + + nmt.script = '' + assertFileContent home-files/.config/smug/blogdemo.yml ${./blogdemo.yml} + ''; +} From feb388ef9f8c9ad93dad16bf2fb65e983bfb54be Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Fri, 28 Mar 2025 16:33:26 +0100 Subject: [PATCH 2/8] Update modules/programs/smug.nix Co-authored-by: Austin Horstman --- modules/programs/smug.nix | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/programs/smug.nix b/modules/programs/smug.nix index 6e04478ed..ac6526b45 100644 --- a/modules/programs/smug.nix +++ b/modules/programs/smug.nix @@ -37,7 +37,9 @@ in { options = { root = mkOptionRoot '' Root path in filesystem of the smug project. This is where tmux - changes its directory to. Defaults to $HOME. + changes its directory to. + + Application defaults to `$HOME`. ''; windows = lib.mkOption { From 59c62728a167b92fe84b10774357ff5717577398 Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Fri, 28 Mar 2025 16:34:56 +0100 Subject: [PATCH 3/8] Update modules/programs/smug.nix Co-authored-by: Austin Horstman --- modules/programs/smug.nix | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/programs/smug.nix b/modules/programs/smug.nix index ac6526b45..320566710 100644 --- a/modules/programs/smug.nix +++ b/modules/programs/smug.nix @@ -97,7 +97,6 @@ in { Type of pane. ''; }; - }; }])); }; From d7eebda699ba3d8d89537c2a1410459b247d067f Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Fri, 28 Mar 2025 16:35:05 +0100 Subject: [PATCH 4/8] Update modules/programs/smug.nix Co-authored-by: Austin Horstman --- modules/programs/smug.nix | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/programs/smug.nix b/modules/programs/smug.nix index 320566710..b86a351f8 100644 --- a/modules/programs/smug.nix +++ b/modules/programs/smug.nix @@ -100,7 +100,6 @@ in { }; }])); }; - }; }]); description = '' From 2fde3bcb8226a5a7e9072435286ff707dc153de0 Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Fri, 28 Mar 2025 16:36:10 +0100 Subject: [PATCH 5/8] Update modules/programs/smug.nix Co-authored-by: Austin Horstman --- modules/programs/smug.nix | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/programs/smug.nix b/modules/programs/smug.nix index b86a351f8..847c6b41c 100644 --- a/modules/programs/smug.nix +++ b/modules/programs/smug.nix @@ -112,10 +112,12 @@ in { default = null; description = "Environment Variables to set in session."; }; + beforeStart = mkOptionCommands "Commands to execute before the tmux-session starts."; + stop = mkOptionCommands - " Commands to execute after the tmux-session is destroyed."; + "Commands to execute after the tmux-session is destroyed."; }; } From 7ae4d6f7c68910f6ce85aba310134a8462bcb134 Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Fri, 28 Mar 2025 16:38:56 +0100 Subject: [PATCH 6/8] Apply suggestions from code review Co-authored-by: Austin Horstman --- modules/programs/smug.nix | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/modules/programs/smug.nix b/modules/programs/smug.nix index 847c6b41c..287e36a83 100644 --- a/modules/programs/smug.nix +++ b/modules/programs/smug.nix @@ -25,12 +25,7 @@ in { enable = lib.mkEnableOption "Smug session manager"; - package = lib.mkOption { - type = lib.types.package; - default = pkgs.smug; - defaultText = lib.literalExpression "pkgs.smug"; - description = "Package providing {command}`smug`."; - }; + package = lib.mkPackageOption pkgs "smug" { nullable = true; }; projects = lib.mkOption { type = lib.types.attrsOf (lib.types.submodule [{ @@ -118,10 +113,8 @@ in { stop = mkOptionCommands "Commands to execute after the tmux-session is destroyed."; - }; } - ]); default = { }; description = "List of project configurations."; @@ -147,7 +140,7 @@ in { }); in lib.mkIf cfg.enable { - home.packages = [ cfg.package ]; - home.file = { } // (mkProjects cleanedProjects); + home.packages = lib.mkIf (cfg.package != null) [ cfg.package ]; + home.file = mkProjects cleanedProjects; }; } From 383b6742fc55d9f2b45a1e31b5eae5f46ba5d55f Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Fri, 28 Mar 2025 16:55:03 +0100 Subject: [PATCH 7/8] apply suggestion --- modules/programs/smug.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/programs/smug.nix b/modules/programs/smug.nix index 287e36a83..e708f75b0 100644 --- a/modules/programs/smug.nix +++ b/modules/programs/smug.nix @@ -117,7 +117,7 @@ in { } ]); default = { }; - description = "List of project configurations."; + description = "Attribute set with project configurations."; }; }; From d99181fc079e642eb38d90010b2bc17148aa6f62 Mon Sep 17 00:00:00 2001 From: Pim Snel Date: Fri, 28 Mar 2025 17:01:54 +0100 Subject: [PATCH 8/8] run format after suggestions --- modules/programs/smug.nix | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/modules/programs/smug.nix b/modules/programs/smug.nix index e708f75b0..deff749cc 100644 --- a/modules/programs/smug.nix +++ b/modules/programs/smug.nix @@ -32,8 +32,8 @@ in { options = { root = mkOptionRoot '' Root path in filesystem of the smug project. This is where tmux - changes its directory to. - + changes its directory to. + Application defaults to `$HOME`. ''; @@ -107,15 +107,14 @@ in { default = null; description = "Environment Variables to set in session."; }; - + beforeStart = mkOptionCommands "Commands to execute before the tmux-session starts."; - + stop = mkOptionCommands "Commands to execute after the tmux-session is destroyed."; }; - } - ]); + }]); default = { }; description = "Attribute set with project configurations."; };