1
0
mirror of https://github.com/nix-community/home-manager synced 2024-06-30 18:38:31 +02:00
home-manager/modules/programs/scmpuff.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

61 lines
1.5 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let cfg = config.programs.scmpuff;
in {
meta.maintainers = [ maintainers.cpcloud ];
options.programs.scmpuff = {
enable = mkEnableOption (lib.mdDoc ''
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 = lib.mdDoc "Package providing the {command}`scmpuff` tool.";
};
enableBashIntegration = mkOption {
default = true;
type = types.bool;
description = lib.mdDoc ''
Whether to enable Bash integration.
'';
};
enableZshIntegration = mkOption {
default = true;
type = types.bool;
description = lib.mdDoc ''
Whether to enable Zsh integration.
'';
};
enableFishIntegration = mkOption {
default = true;
type = types.bool;
description = lib.mdDoc ''
Whether to enable fish integration.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
programs.bash.initExtra = mkIf cfg.enableBashIntegration ''
eval "$(${cfg.package}/bin/scmpuff init -s)"
'';
programs.zsh.initExtra = mkIf cfg.enableZshIntegration ''
eval "$(${cfg.package}/bin/scmpuff init -s)"
'';
programs.fish.interactiveShellInit = mkIf cfg.enableFishIntegration
(mkAfter ''
${cfg.package}/bin/scmpuff init -s --shell=fish | source
'');
};
}