1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-03-07 01:07:00 +00:00
home-manager/modules/programs/scmpuff.nix
NAHO 5af1b9a0f1
treewide: standardize shell integration options
Standardize all 'programs.<PROGRAM>.enable<SHELL>Integration' options
with the following new functions:

- lib.hm.shell.mkBashIntegrationOption
- lib.hm.shell.mkFishIntegrationOption
- lib.hm.shell.mkIonIntegrationOption
- lib.hm.shell.mkNushellIntegrationOption
- lib.hm.shell.mkZshIntegrationOption

These functions should default to their corresponding global option:

- home.shell.enableBashIntegration
- home.shell.enableFishIntegration
- home.shell.enableIonIntegration
- home.shell.enableNushellIntegration
- home.shell.enableZshIntegration

All these global options default to the
'home.shell.enableShellIntegration' value.

This hierarchy standardizes the shell integration and increases end-user
flexibility.

BREAKING CHANGE: The following inconsistent default values change from
'false' to 'true':

- programs.zellij.enableBashIntegration
- programs.zellij.enableFishIntegration
- programs.zellij.enableZshIntegration

Link: https://github.com/nix-community/home-manager/pull/6358

Co-authored-by: Robert Helgesson <robert@rycee.net>
2025-02-08 22:49:40 +01:00

57 lines
1.6 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let cfg = config.programs.scmpuff;
in {
meta.maintainers = [ maintainers.cpcloud ];
options.programs.scmpuff = {
enable = mkEnableOption ''
scmpuff, a command line tool that allows you to work quicker with Git by
substituting numeric shortcuts for files'';
package = mkOption {
type = types.package;
default = pkgs.scmpuff;
defaultText = literalExpression "pkgs.scmpuff";
description = "Package providing the {command}`scmpuff` tool.";
};
enableBashIntegration =
lib.hm.shell.mkBashIntegrationOption { inherit config; };
enableFishIntegration =
lib.hm.shell.mkFishIntegrationOption { inherit config; };
enableZshIntegration =
lib.hm.shell.mkZshIntegrationOption { inherit config; };
enableAliases = mkOption {
default = true;
type = types.bool;
description = ''
Whether to enable aliases (e.g. gs, ga, gd, gco).
'';
};
};
config = mkIf cfg.enable (let
mkArgs = shell:
concatStringsSep " " ([ "--shell=${shell}" ]
++ optional (!cfg.enableAliases) "--aliases=false");
in {
home.packages = [ cfg.package ];
programs.bash.initExtra = mkIf cfg.enableBashIntegration ''
eval "$(${cfg.package}/bin/scmpuff init ${mkArgs "bash"})"
'';
programs.zsh.initExtra = mkIf cfg.enableZshIntegration ''
eval "$(${cfg.package}/bin/scmpuff init ${mkArgs "zsh"})"
'';
programs.fish.interactiveShellInit = mkIf cfg.enableFishIntegration
(mkAfter ''
${cfg.package}/bin/scmpuff init ${mkArgs "fish"} | source
'');
});
}