skim: add module

1 files changed, 128 insertions, 0 deletions

diff --git a/modules/programs/skim.nix b/modules/programs/skim.nix
new file mode 100644
index 00000000000..4b8f8ee37e0
--- /dev/null
+++ b/modules/programs/skim.nix
@@ -0,0 +1,128 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.programs.skim;
+
+in
+
+{
+  options.programs.skim = {
+    enable = mkEnableOption "skim - a command-line fuzzy finder";
+
+    defaultCommand = mkOption {
+      type = types.nullOr types.str;
+      default = null;
+      example = "fd --type f";
+      description = ''
+        The command that gets executed as the default source for skim
+        when running.
+      '';
+    };
+
+    defaultOptions = mkOption {
+      type = types.listOf types.str;
+      default = [];
+      example = [ "--height 40%" "--prompt ⟫" ];
+      description = ''
+        Extra command line options given to skim by default.
+      '';
+    };
+
+    fileWidgetCommand = mkOption {
+      type = types.nullOr types.str;
+      default = null;
+      example = "fd --type f";
+      description = ''
+        The command that gets executed as the source for skim for the
+        CTRL-T keybinding.
+      '';
+    };
+
+    fileWidgetOptions = mkOption {
+      type = types.listOf types.str;
+      default = [];
+      example = [ "--preview 'head {}'" ];
+      description = ''
+        Command line options for the CTRL-T keybinding.
+      '';
+    };
+
+    changeDirWidgetCommand = mkOption {
+      type = types.nullOr types.str;
+      default = null;
+      example = "fd --type d" ;
+      description = ''
+        The command that gets executed as the source for skim for the
+        ALT-C keybinding.
+      '';
+    };
+
+    changeDirWidgetOptions = mkOption {
+      type = types.listOf types.str;
+      default = [];
+      example = [ "--preview 'tree -C {} | head -200'" ];
+      description = ''
+        Command line options for the ALT-C keybinding.
+      '';
+    };
+
+    historyWidgetOptions = mkOption {
+      type = types.listOf types.str;
+      default = [];
+      example = [ "--tac" "--exact" ];
+      description = ''
+        Command line options for the CTRL-R keybinding.
+      '';
+    };
+
+    enableBashIntegration = mkOption {
+      default = true;
+      type = types.bool;
+      description = ''
+        Whether to enable Bash integration.
+      '';
+    };
+
+    enableZshIntegration = mkOption {
+      default = true;
+      type = types.bool;
+      description = ''
+        Whether to enable Zsh integration.
+      '';
+    };
+  };
+
+  config = mkIf cfg.enable {
+    home.packages = [ pkgs.skim ];
+
+    home.sessionVariables =
+      mapAttrs (n: v: toString v) (
+        filterAttrs (n: v: v != [] && v != null) {
+          SKIM_ALT_C_COMMAND = cfg.changeDirWidgetCommand;
+          SKIM_ALT_C_OPTS = cfg.changeDirWidgetOptions;
+          SKIM_CTRL_R_OPTS = cfg.historyWidgetOptions;
+          SKIM_CTRL_T_COMMAND = cfg.fileWidgetCommand;
+          SKIM_CTRL_T_OPTS = cfg.fileWidgetOptions;
+          SKIM_DEFAULT_COMMAND = cfg.defaultCommand;
+          SKIM_DEFAULT_OPTS = cfg.defaultOptions;
+        }
+      );
+
+    programs.bash.initExtra = mkIf cfg.enableBashIntegration ''
+      if [[ :$SHELLOPTS: =~ :(vi|emacs): ]]; then
+        . ${pkgs.skim}/share/skim/completion.bash
+        . ${pkgs.skim}/share/skim/key-bindings.bash
+      fi
+    '';
+
+    programs.zsh.initExtra = mkIf cfg.enableZshIntegration ''
+      if [[ $options[zle] = on ]]; then
+        . ${pkgs.skim}/share/skim/completion.zsh
+        . ${pkgs.skim}/share/skim/key-bindings.zsh
+      fi
+    '';
+  };
+}