aboutsummaryrefslogtreecommitdiffstats
path: root/modules/scripts/default.nix
diff options
context:
space:
mode:
authorArpit Chakladar <arpitchakladar+git@gmail.com>2026-07-18 14:55:21 +0530
committerArpit Chakladar <arpitchakladar+git@gmail.com>2026-07-18 14:55:21 +0530
commit03bd9b6ad5335aff65d9cb6fb1d117b5cb4b7919 (patch)
tree04780c0d23aac335fe60320c181bd3ac6850d5d3 /modules/scripts/default.nix
parentbde84587b2a408970086f4c708ac9a629abfa554 (diff)
downloadhome-manager-config-03bd9b6ad5335aff65d9cb6fb1d117b5cb4b7919.tar.gz
home-manager-config-03bd9b6ad5335aff65d9cb6fb1d117b5cb4b7919.zip
refactor(scripts): split monolithic module into per-script submodules
Extract shared `mkScript` and `mkScriptModule` helpers into `lib.nix` Split each script into `modules/scripts/<name>/` with its own `default.nix`, `script.sh`, and `assertions.nix` Remove `conditions` parameter from `mkScriptModule`; move condition assertions into per-script `assertions.nix` files with inline checks and error messages Simplify `mkScriptModule` to return `{ options, moduleConfig }` instead of a module function, taking `config` as a direct parameter Add `description` field to `mkScript` that inserts the description as a `# <text>` comment between the shebang and env vars Thread `description` through `mkScriptModule` to each `default.nix` Move top comment lines from each `script.sh` into the `description` field and remove from sources to avoid duplication Remove old flat `.sh` files from `modules/scripts/` root
Diffstat (limited to 'modules/scripts/default.nix')
-rw-r--r--modules/scripts/default.nix365
1 files changed, 30 insertions, 335 deletions
diff --git a/modules/scripts/default.nix b/modules/scripts/default.nix
index 789c32d..abecc38 100644
--- a/modules/scripts/default.nix
+++ b/modules/scripts/default.nix
@@ -1,351 +1,46 @@
-# Scripts - Generates wrapped scripts with environment variables and dependencies
{
config,
lib,
pkgs,
...
}:
-let
- shell = pkgs.runtimeShell;
-
- mkScript =
- name: path: env: deps:
- let
- envVars = lib.concatStringsSep "\n" (lib.mapAttrsToList (n: v: "${n}=\"${toString v}\"") env);
- wrappedScript = pkgs.writeTextFile {
- name = name;
- executable = true;
- destination = "/bin/${name}";
- text = ''
- #!${shell}
- ${envVars}
- ${builtins.readFile path}
- '';
- };
- in
- pkgs.runCommand name
- {
- name = name;
- nativeBuildInputs = [ pkgs.makeWrapper ];
- meta.mainProgram = name;
- }
- ''
- mkdir -p $out/bin
- cp ${wrappedScript}/bin/${name} $out/bin/${name}
- chmod +x $out/bin/${name}
-
- wrapProgram $out/bin/${name} \
- --prefix PATH : ${lib.makeBinPath deps}
- '';
-
- # Script definitions: { path, env?, deps?, conditions? }
- # condition: attrset of { option (string path), value (expected value) }
- scriptDefs = {
- aria2-run = {
- path = ./aria2-run.sh;
- deps = [
- config.web.aria2.package
- ];
- conditions = [
- {
- option = "web.aria2.enable";
- value = true;
- }
- ];
- };
- deep-clean = {
- path = ./deep-clean.sh;
- };
- file-preview = {
- path = ./file-preview.sh;
- deps = [
- config.terminal.kitty.package
- config.terminal.bat.package
- config.media.ffmpeg.package
- config.file-management.ouch.package
- pkgs.coreutils
- pkgs.file
- pkgs.findutils
- pkgs.fontconfig
- pkgs.librsvg
- pkgs.antiword
- pkgs.pandoc
- pkgs.poppler-utils
- pkgs.util-linux
- ];
- conditions = [
- {
- option = "terminal.kitty.enable";
- value = true;
- }
- {
- option = "media.ffmpeg.enable";
- value = true;
- }
- {
- option = "file-management.ouch.enable";
- value = true;
- }
- {
- option = "terminal.bat.enable";
- value = true;
- }
- ];
- };
- file-preview-clean = {
- path = ./file-preview-clean.sh;
- deps = [
- config.terminal.kitty.package
- ];
- conditions = [
- {
- option = "scripts.file-preview.enable";
- value = true;
- }
- ];
- };
- fzf-launcher = {
- path = ./fzf-launcher.sh;
- deps = [
- config.terminal.fzf.package
- pkgs.dex
- pkgs.util-linux
- ];
- conditions = [
- {
- option = "terminal.fzf.enable";
- value = true;
- }
- ];
- };
- i3-keybindings = {
- path = ./i3-keybindings.sh;
- deps = [
- pkgs.coreutils
- pkgs.gawk
- pkgs.ncurses
- ];
- conditions = [
- {
- option = "desktop.enable";
- value = true;
- }
- {
- option = "terminal.less.enable";
- value = true;
- }
- ];
- };
- screen-recording = {
- path = ./screen-recording.sh;
- deps = [
- config.media.ffmpeg.package
- config.media.slop.package
- ];
- conditions = [
- {
- option = "media.ffmpeg.enable";
- value = true;
- }
- {
- option = "media.slop.enable";
- value = true;
- }
- ];
- };
- system-monitor = {
- path = ./system-monitor.sh;
- deps = [
- config.system.bottom.package
- config.system.nvtop.package
- config.terminal.tmux.package
- config.terminal.kitty.package
- pkgs.bash
- ];
- conditions = [
- {
- option = "system.bottom.enable";
- value = true;
- }
- {
- option = "system.nvtop.enable";
- value = true;
- }
- {
- option = "terminal.tmux.enable";
- value = true;
- }
- {
- option = "terminal.kitty.enable";
- value = true;
- }
- ];
- };
- vpn-connect = {
- path = ./vpn-connect.sh;
- env = {
- SYSTEMD_RESOLVED_PATH = "${config.security.openvpn.package}/libexec/update-systemd-resolved";
- };
- deps = [
- config.terminal.fzf.package
- config.security.openvpn.package
- pkgs.coreutils
- pkgs.findutils
- pkgs.gnugrep
- pkgs.gnused
- ];
- conditions = [
- {
- option = "security.openvpn.enable";
- value = true;
- }
- {
- option = "terminal.fzf.enable";
- value = true;
- }
- ];
- };
- vpn-disconnect = {
- path = ./vpn-disconnect.sh;
- conditions = [
- {
- option = "scripts.vpn-connect.enable";
- value = true;
- }
- ];
- };
- neomutt-sync = {
- path = ./neomutt-sync.sh;
- deps = [
- pkgs.dialog
- pkgs.coreutils
- pkgs.gawk
- pkgs.gnused
- pkgs.util-linux
- config.programs.mbsync.package
- config.programs.notmuch.package
- ];
- conditions = [
- {
- option = "communication.neomutt.enable";
- value = true;
- }
- ];
- };
- };
-
- # Check whether all conditions for a script are satisfied
- conditionsMet =
- name: def:
- lib.all (cond: lib.attrByPath (lib.splitString "." cond.option) false config == cond.value) (
- def.conditions or [ ]
- );
-
- # Generate a .desktop entry that launches the script in kitty
- mkDesktopItem =
- name: def:
- let
- sc = config.scripts.${name};
- in
- if sc.enable && sc.desktop.enable then
- pkgs.makeDesktopItem {
- name = name;
- desktopName = sc.desktop.displayName;
- exec = "${lib.getExe config.terminal.kitty.package} -e ${lib.getExe sc.package}";
- icon = "kitty";
- categories = [ "Utility" ];
- terminal = false;
- type = "Application";
- }
- else
- null;
-
- desktopItems = lib.mapAttrsToList mkDesktopItem scriptDefs;
-
-in
{
- options.scripts = lib.mapAttrs (name: def: {
- enable = lib.mkOption {
- type = lib.types.bool;
- # Auto-enable if all required tool options are satisfied
- default = conditionsMet name def;
- description = ''
- Whether to enable the ${name} script.
- Defaults to true when all required options are set.
- '';
- };
- package = lib.mkOption {
- type = lib.types.nullOr lib.types.package;
- readOnly = true;
- description = "The derivation for the ${name} script. Set automatically when enabled.";
- };
- desktop = {
- enable = lib.mkOption {
- type = lib.types.bool;
- default = false;
- description = "Whether to create a .desktop entry for this script.";
- };
- displayName = lib.mkOption {
- type = lib.types.str;
- default = name;
- description = "Display name for the .desktop entry.";
- };
- };
- }) scriptDefs;
+ imports = [
+ ./aria2-run
+ ./deep-clean
+ ./file-preview
+ ./file-preview-clean
+ ./fzf-launcher
+ ./i3-keybindings
+ ./neomutt-sync
+ ./screen-recording
+ ./system-monitor
+ ./vpn-connect
+ ./vpn-disconnect
+ ];
config = {
- # Wire up .package for each enabled script, with assertions for unmet conditions
- scripts =
- lib.recursiveUpdate
- (lib.mapAttrs (name: def: {
- package = lib.mkIf config.scripts.${name}.enable (
- mkScript name def.path (def.env or { }) (def.deps or [ ])
- );
- }) scriptDefs)
- {
- aria2-run.desktop = {
- enable = true;
- displayName = "Aria2 Download Manager";
- };
- i3-keybindings.desktop = {
- enable = true;
- displayName = "i3 Keybindings";
- };
- screen-recording.desktop = {
- enable = true;
- displayName = "Screen Recording";
- };
- system-monitor.desktop = {
- enable = true;
- displayName = "System Monitor";
- };
- };
-
- assertions =
- lib.concatLists (
- lib.mapAttrsToList (
- name: def:
- map (cond: {
- assertion =
- !config.scripts.${name}.enable
- || lib.attrByPath (lib.splitString "." cond.option) false config == cond.value;
- message = "scripts.${name} is enabled but requires `${cond.option} = ${builtins.toJSON cond.value}`.";
- }) (def.conditions or [ ])
- ) scriptDefs
- )
- ++ lib.mapAttrsToList (name: _: {
- assertion =
- !config.scripts.${name}.enable
- || !config.scripts.${name}.desktop.enable
- || config.terminal.kitty.enable;
- message = "scripts.${name}.desktop.enable requires terminal.kitty.enable because desktop entries launch scripts in kitty.";
- }) scriptDefs;
-
home.packages = [
pkgs.file
config.terminal.bat.package
]
++ lib.filter (x: x != null) (lib.mapAttrsToList (_: s: s.package) config.scripts)
- ++ lib.filter (x: x != null) desktopItems;
+ ++ lib.filter (x: x != null) (
+ lib.mapAttrsToList (
+ name: sc:
+ if sc.enable && sc.desktop.enable then
+ pkgs.makeDesktopItem {
+ name = name;
+ desktopName = sc.desktop.displayName;
+ exec = "${lib.getExe config.terminal.kitty.package} -e ${lib.getExe sc.package}";
+ icon = "kitty";
+ categories = [ "Utility" ];
+ terminal = false;
+ type = "Application";
+ }
+ else
+ null
+ ) config.scripts
+ );
};
}