nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

gh: use structural settings (#2339)

Browse source
This commit is contained in:
Nicolas Berbiche 2021-10-08 23:29:25 +02:00 • committed by GitHub
parent fd2f746016
commit 82c92a18ba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 123 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

104
modules/programs/gh.nix
View file

@ -6,50 +6,96 @@ let
cfg = config.programs.gh;
yamlFormat = pkgs.formats.yaml { };
settingsType = types.submodule {
freeformType = yamlFormat.type;
# These options are only here for the mkRenamedOptionModule support
options = {
aliases = mkOption {
type = with types; attrsOf str;
default = { };
example = literalExample ''
{
co = "pr checkout";
pv = "pr view";
}
'';
description = ''
Aliases that allow you to create nicknames for gh commands.
'';
};
editor = mkOption {
type = types.str;
default = "";
description = ''
The editor that gh should run when creating issues, pull requests, etc.
If blank, will refer to environment.
'';
};
git_protocol = mkOption {
type = types.str;
default = "https";
example = "ssh";
description = ''
The protocol to use when performing Git operations.
'';
};
};
};
in {
meta.maintainers = [ maintainers.gerschtli ];
meta.maintainers = [ maintainers.gerschtli maintainers.berbiche ];
imports = (map (x:
mkRenamedOptionModule [ "programs" "gh" x ] [
"programs"
"gh"
"settings"
x
]) [ "aliases" "editor" ]) ++ [
(mkRenamedOptionModule [ "programs" "gh" "gitProtocol" ] [
"programs"
"gh"
"settings"
"git_protocol"
])
];
options.programs.gh = {
enable = mkEnableOption "GitHub CLI tool";
aliases = mkOption {
type = with types; attrsOf str;
package = mkOption {
type = types.package;
default = pkgs.gh;
defaultText = literalExample "pkgs.gh";
description = "Package providing <command>gh</command>.";
};
settings = mkOption {
type = settingsType;
default = { };
description =
"Configuration written to <filename>$XDG_CONFIG_HOME/gh/config.yml</filename>.";
example = literalExample ''
{
co = "pr checkout";
pv = "pr view";
}
'';
description = ''
Aliases that allow you to create nicknames for gh commands.
'';
};
git_protocol = "ssh";
editor = mkOption {
type = types.str;
default = "";
description = ''
The editor that gh should run when creating issues, pull requests, etc.
If blank, will refer to environment.
'';
};
prompt = "enabled";
gitProtocol = mkOption {
type = types.enum [ "https" "ssh" ];
default = "https";
description = ''
The protocol to use when performing Git operations.
aliases = {
co = "pr checkout";
pv = "pr view";
};
};
'';
};
};
config = mkIf cfg.enable {
home.packages = [ pkgs.gh ];
home.packages = [ cfg.package ];
xdg.configFile."gh/config.yml".text = builtins.toJSON {
inherit (cfg) aliases editor;
git_protocol = cfg.gitProtocol;
};
xdg.configFile."gh/config.yml".source =
yamlFormat.generate "gh-config.yml" cfg.settings;
};
}