9f9e277b60
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.
Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.
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 \
--strip {} +
$ ./format
127 lines
3 KiB
Nix
127 lines
3 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
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 = literalExpression ''
|
|
{
|
|
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 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";
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.gh;
|
|
defaultText = literalExpression "pkgs.gh";
|
|
description = "Package providing {command}`gh`.";
|
|
};
|
|
|
|
settings = mkOption {
|
|
type = settingsType;
|
|
default = { };
|
|
description =
|
|
"Configuration written to {file}`$XDG_CONFIG_HOME/gh/config.yml`.";
|
|
example = literalExpression ''
|
|
{
|
|
git_protocol = "ssh";
|
|
|
|
prompt = "enabled";
|
|
|
|
aliases = {
|
|
co = "pr checkout";
|
|
pv = "pr view";
|
|
};
|
|
};
|
|
'';
|
|
};
|
|
|
|
enableGitCredentialHelper =
|
|
mkEnableOption "the gh git credential helper for github.com" // {
|
|
default = true;
|
|
};
|
|
|
|
extensions = mkOption {
|
|
type = types.listOf types.package;
|
|
default = [ ];
|
|
description = ''
|
|
gh extensions, see <https://cli.github.com/manual/gh_extension>.
|
|
'';
|
|
example = literalExpression "[ pkgs.gh-eco ]";
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
home.packages = [ cfg.package ];
|
|
|
|
xdg.configFile."gh/config.yml".source =
|
|
yamlFormat.generate "gh-config.yml" cfg.settings;
|
|
|
|
programs.git.extraConfig.credential."https://github.com".helper =
|
|
mkIf cfg.enableGitCredentialHelper
|
|
"${cfg.package}/bin/gh auth git-credential";
|
|
|
|
xdg.dataFile."gh/extensions" = mkIf (cfg.extensions != [ ]) {
|
|
source = pkgs.linkFarm "gh-extensions" (builtins.map (p: {
|
|
name = p.pname;
|
|
path = "${p}/bin";
|
|
}) cfg.extensions);
|
|
};
|
|
};
|
|
}
|