home-manager/modules/programs/git.nix

304 lines
8.6 KiB
Nix
Raw Normal View History

2017-01-07 19:16:26 +01:00
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.git;
# create [section "subsection"] keys from "section.subsection" attrset names
mkSectionName = name:
let
containsQuote = strings.hasInfix ''"'' name;
sections = splitString "." name;
section = head sections;
subsections = tail sections;
subsection = concatStringsSep "." subsections;
2020-02-02 00:39:17 +01:00
in if containsQuote || subsections == [ ] then
name
else
''${section} "${subsection}"'';
# generation for multiple ini values
mkKeyValue = k: v:
let mkKeyValue = generators.mkKeyValueDefault { } " = " k;
in concatStringsSep "\n" (map (kv: " " + mkKeyValue kv) (toList v));
# converts { a.b.c = 5; } to { "a.b".c = 5; } for toINI
2020-02-02 00:39:17 +01:00
gitFlattenAttrs = let
recurse = path: value:
if isAttrs value then
mapAttrsToList (name: value: recurse ([ name ] ++ path) value) value
else if length path > 1 then {
${concatStringsSep "." (reverseList (tail path))}.${head path} = value;
} else {
${head path} = value;
};
in attrs: foldl recursiveUpdate { } (flatten (recurse [ ] attrs));
gitToIni = attrs:
2020-02-02 00:39:17 +01:00
let toIni = generators.toINI { inherit mkKeyValue mkSectionName; };
in toIni (gitFlattenAttrs attrs);
gitIniType = with types;
let
primitiveType = either str (either bool int);
multipleType = either primitiveType (listOf primitiveType);
sectionType = attrsOf multipleType;
supersectionType = attrsOf (either multipleType sectionType);
2020-02-02 00:39:17 +01:00
in attrsOf supersectionType;
2017-08-24 01:03:01 +02:00
signModule = types.submodule {
options = {
key = mkOption {
type = types.str;
description = "The default GPG signing key fingerprint.";
};
signByDefault = mkOption {
type = types.bool;
default = false;
description = "Whether commits should be signed by default.";
};
gpgPath = mkOption {
type = types.str;
default = "${pkgs.gnupg}/bin/gpg2";
defaultText = "\${pkgs.gnupg}/bin/gpg2";
description = "Path to GnuPG binary to use.";
2017-01-07 19:16:26 +01:00
};
2017-08-24 01:03:01 +02:00
};
};
2017-01-07 19:16:26 +01:00
2019-01-29 12:33:10 +01:00
includeModule = types.submodule ({ config, ... }: {
2018-04-18 23:41:20 +02:00
options = {
condition = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Include this configuration only when <varname>condition</varname>
matches. Allowed conditions are described in
<citerefentry>
<refentrytitle>git-config</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>.
'';
};
path = mkOption {
2019-01-29 12:33:10 +01:00
type = with types; either str path;
2018-04-18 23:41:20 +02:00
description = "Path of the configuration file to include.";
};
2019-01-29 12:33:10 +01:00
contents = mkOption {
type = types.attrs;
2020-02-02 00:39:17 +01:00
default = { };
2019-01-29 12:33:10 +01:00
description = ''
Configuration to include. If empty then a path must be given.
'';
};
2018-04-18 23:41:20 +02:00
};
2019-01-29 12:33:10 +01:00
2020-02-02 00:39:17 +01:00
config.path = mkIf (config.contents != { })
(mkDefault (pkgs.writeText "contents" (gitToIni config.contents)));
2019-01-29 12:33:10 +01:00
});
2018-04-18 23:41:20 +02:00
2020-02-02 00:39:17 +01:00
in {
meta.maintainers = [ maintainers.rycee ];
2017-01-07 19:16:26 +01:00
options = {
programs.git = {
enable = mkEnableOption "Git";
package = mkOption {
type = types.package;
default = pkgs.git;
defaultText = literalExample "pkgs.git";
description = ''
Git package to install. Use <varname>pkgs.gitAndTools.gitFull</varname>
to gain access to <command>git send-email</command> for instance.
'';
2017-01-07 19:16:26 +01:00
};
userName = mkOption {
type = types.nullOr types.str;
default = null;
2017-01-07 19:16:26 +01:00
description = "Default user name to use.";
};
userEmail = mkOption {
type = types.nullOr types.str;
default = null;
2017-01-07 19:16:26 +01:00
description = "Default user email to use.";
};
aliases = mkOption {
type = types.attrsOf types.str;
2020-02-02 00:39:17 +01:00
default = { };
example = { co = "checkout"; };
2017-01-07 19:16:26 +01:00
description = "Git aliases to define.";
};
signing = mkOption {
type = types.nullOr signModule;
default = null;
description = "Options related to signing commits using GnuPG.";
};
extraConfig = mkOption {
type = types.either types.lines gitIniType;
2020-02-02 00:39:17 +01:00
default = { };
example = {
core = { whitespace = "trailing-space,space-before-tab"; };
url."ssh://git@host".insteadOf = "otherhost";
};
2019-08-30 14:50:10 +02:00
description = ''
Additional configuration to add. The use of string values is
deprecated and will be removed in the future.
'';
2017-01-07 19:16:26 +01:00
};
iniContent = mkOption {
type = gitIniType;
internal = true;
};
ignores = mkOption {
type = types.listOf types.str;
2020-02-02 00:39:17 +01:00
default = [ ];
example = [ "*~" "*.swp" ];
description = "List of paths that should be globally ignored.";
};
2018-04-18 23:41:20 +02:00
2019-09-24 11:20:00 +02:00
attributes = mkOption {
type = types.listOf types.str;
2020-02-02 00:39:17 +01:00
default = [ ];
2019-09-24 11:20:00 +02:00
example = [ "*.pdf diff=pdf" ];
description = "List of defining attributes set globally.";
};
2018-04-18 23:41:20 +02:00
includes = mkOption {
type = types.listOf includeModule;
2020-02-02 00:39:17 +01:00
default = [ ];
2018-04-18 23:41:20 +02:00
example = literalExample ''
[
{ path = "~/path/to/config.inc"; }
{
path = "~/path/to/conditional.inc";
condition = "gitdir:~/src/dir";
}
]
'';
description = "List of configuration files to include.";
};
lfs = {
enable = mkEnableOption "Git Large File Storage";
skipSmudge = mkOption {
type = types.bool;
default = false;
description = ''
Skip automatic downloading of objects on clone or pull.
This requires a manual <command>git lfs pull</command>
every time a new commit is checked out on your repository.
'';
};
};
2017-01-07 19:16:26 +01:00
};
};
2020-02-02 00:39:17 +01:00
config = mkIf cfg.enable (mkMerge [
{
home.packages = [ cfg.package ];
2020-02-02 00:39:17 +01:00
programs.git.iniContent.user = {
name = mkIf (cfg.userName != null) cfg.userName;
email = mkIf (cfg.userEmail != null) cfg.userEmail;
};
2017-01-07 19:16:26 +01:00
2020-02-02 00:39:17 +01:00
xdg.configFile = {
"git/config".text = gitToIni cfg.iniContent;
2020-02-02 00:39:17 +01:00
"git/ignore" = mkIf (cfg.ignores != [ ]) {
text = concatStringsSep "\n" cfg.ignores + "\n";
};
2019-09-24 11:20:00 +02:00
2020-02-02 00:39:17 +01:00
"git/attributes" = mkIf (cfg.attributes != [ ]) {
text = concatStringsSep "\n" cfg.attributes + "\n";
};
2020-02-02 00:39:17 +01:00
};
}
{
programs.git.iniContent = let
hasSmtp = name: account: account.smtp != null;
genIdentity = name: account:
with account;
nameValuePair "sendemail.${name}" ({
smtpEncryption = if smtp.tls.enable then "tls" else "";
smtpServer = smtp.host;
smtpUser = userName;
from = address;
} // optionalAttrs (smtp.port != null) {
smtpServerPort = smtp.port;
});
in mapAttrs' genIdentity
(filterAttrs hasSmtp config.accounts.email.accounts);
}
(mkIf (cfg.signing != null) {
programs.git.iniContent = {
user.signingKey = cfg.signing.key;
commit.gpgSign = cfg.signing.signByDefault;
gpg.program = cfg.signing.gpgPath;
};
})
(mkIf (cfg.aliases != { }) { programs.git.iniContent.alias = cfg.aliases; })
(mkIf (lib.isAttrs cfg.extraConfig) {
programs.git.iniContent = cfg.extraConfig;
})
(mkIf (lib.isString cfg.extraConfig) {
warnings = [''
Using programs.git.extraConfig as a string option is
deprecated and will be removed in the future. Please
change to using it as an attribute set instead.
''];
xdg.configFile."git/config".text = cfg.extraConfig;
})
(mkIf (cfg.includes != [ ]) {
xdg.configFile."git/config".text = let
include = i:
with i;
if condition != null then {
includeIf.${condition}.path = "${path}";
} else {
include.path = "${path}";
};
in mkAfter
(concatStringsSep "\n" (map gitToIni (map include cfg.includes)));
})
(mkIf cfg.lfs.enable {
home.packages = [ pkgs.git-lfs ];
programs.git.iniContent.filter.lfs =
let skipArg = optional cfg.lfs.skipSmudge "--skip";
in {
clean = "git-lfs clean -- %f";
process =
concatStringsSep " " ([ "git-lfs" "filter-process" ] ++ skipArg);
required = true;
smudge = concatStringsSep " "
([ "git-lfs" "smudge" ] ++ skipArg ++ [ "--" "%f" ]);
};
2020-02-02 00:39:17 +01:00
})
]);
2017-01-07 19:16:26 +01:00
}