mergiraf: add 'enable{Git,Jujutsus}Integration'

This commit is contained in:
Bruno BELANYI 2026-03-12 03:52:41 +01:00 committed by GitHub
parent 32f78141a9
commit d7ef0034e3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 142 additions and 18 deletions

View file

@ -0,0 +1,13 @@
{ config, ... }:
{
time = "2026-02-23T17:02:43+00:00";
condition = config.programs.mergiraf.enable;
message = ''
The `programs.mergiraf` module's Git and Jujutsu integration are now gated
behind `programs.mergiraf.enableGitIntegration` (respectively
`enableJujutsuIntegration`).
They are enabled by default for `stateVersion < 26.04`, and otherwise need
to be explicitly enabled.
'';
}

View file

@ -2,6 +2,7 @@
pkgs,
config,
lib,
options,
...
}:
let
@ -12,7 +13,6 @@ let
maintainers
;
cfg = config.programs.mergiraf;
mergiraf = "${cfg.package}/bin/mergiraf";
in
{
meta.maintainers = [ maintainers.bobvanderlinden ];
@ -20,28 +20,105 @@ in
options = {
programs.mergiraf = {
enable = mkEnableOption "mergiraf";
package = mkPackageOption pkgs "mergiraf" { };
enableGitIntegration = lib.mkOption {
type = lib.types.bool;
default = lib.versionOlder config.home.stateVersion "26.05";
defaultText = ''lib.versionOlder config.home.stateVersion "26.05"'';
description = ''
Whether to enable git integration for mergiraf.
When enabled, mergiraf will be configured as git's merge driver.
'';
};
enableJujutsuIntegration = lib.mkOption {
type = lib.types.bool;
default = lib.versionOlder config.home.stateVersion "26.05";
defaultText = ''lib.versionOlder config.home.stateVersion "26.05"'';
description = ''
Whether to enable jujutsu integration for mergiraf.
When enabled, mergiraf will be configured as jujutsus's merge tool.
'';
};
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
config = lib.mkMerge [
{
warnings =
lib.optionals
(
cfg.enable
&& !lib.versionAtLeast config.home.stateVersion "26.05"
&& options.programs.mergiraf.enableGitIntegration.highestPrio >= 1500
)
[
''
The default value of `programs.mergiraf.enableGitIntegration` will change in future versions.
You are currently using the legacy default (true) because `home.stateVersion` is less than "26.05".
To silence this warning set:
programs.mergiraf.enableGitIntegration = true;
''
]
++
lib.optionals
(
cfg.enable
&& !lib.versionAtLeast config.home.stateVersion "26.05"
&& options.programs.mergiraf.enableJujutsuIntegration.highestPrio >= 1500
)
[
''
The default value of `programs.mergiraf.enableJujutsuIntegration` will change in future versions.
You are currently using the legacy default (true) because `home.stateVersion` is less than "26.05".
To silence this warning set:
programs.mergiraf.enableJujutsuIntegration = true;
''
];
}
programs = {
git = {
attributes = [ "* merge=mergiraf" ];
settings = {
merge = {
mergiraf = {
name = "mergiraf";
driver = "${mergiraf} merge --git %O %A %B -s %S -x %X -y %Y -p %P -l %L";
(mkIf cfg.enable {
home.packages = [ cfg.package ];
})
(mkIf (cfg.enable && cfg.enableGitIntegration) {
programs = {
git = {
attributes = [ "* merge=mergiraf" ];
settings = {
merge = {
mergiraf = {
name = "mergiraf";
driver = "${lib.getExe cfg.package} merge --git %O %A %B -s %S -x %X -y %Y -p %P -l %L";
};
conflictStyle = "diff3";
};
conflictStyle = "diff3";
};
};
};
})
jujutsu.settings.ui.merge-editor = "mergiraf";
};
};
(mkIf (cfg.enable && cfg.enableJujutsuIntegration) {
programs = {
jujutsu = {
settings = {
ui = {
# Rely on the built-in configuration
merge-editor = "mergiraf";
};
# Explicitly set the path to the package
merge-tools = {
mergiraf = {
program = lib.getExe cfg.package;
};
};
};
};
};
})
];
}

View file

@ -1,4 +1,5 @@
{
mergiraf-basic-configuration = ./basic-configuration.nix;
mergiraf-git-integration = ./git-integration.nix;
mergiraf-jujutsu-integration = ./jujutsu-integration.nix;
mergiraf-legacy-warnings = ./legacy-warnings.nix;
}

View file

@ -1,6 +1,11 @@
{
programs.git.enable = true;
programs.mergiraf.enable = true;
programs.mergiraf = {
enable = true;
enableGitIntegration = true;
# Do not warn about default value
enableJujutsuIntegration = false;
};
nmt.script = ''
assertFileContent "home-files/.config/git/config" ${./mergiraf-git.conf}

View file

@ -20,12 +20,20 @@ in
enable = true;
package = config.lib.test.mkStubPackage { };
};
programs.mergiraf.enable = true;
programs.mergiraf = {
enable = true;
enableJujutsuIntegration = true;
# Do not warn about default value
enableGitIntegration = false;
};
nmt.script = ''
assertFileExists 'home-files/${configDir}/jj/config.toml'
assertFileContent 'home-files/${configDir}/jj/config.toml' \
${builtins.toFile "expected.toml" ''
[merge-tools.mergiraf]
program = "@mergiraf@/bin/mergiraf"
[ui]
merge-editor = "mergiraf"
''}

View file

@ -0,0 +1,20 @@
{
programs.mergiraf = {
enable = true;
};
test.asserts.warnings.expected = [
''
The default value of `programs.mergiraf.enableGitIntegration` will change in future versions.
You are currently using the legacy default (true) because `home.stateVersion` is less than "26.05".
To silence this warning set:
programs.mergiraf.enableGitIntegration = true;
''
''
The default value of `programs.mergiraf.enableJujutsuIntegration` will change in future versions.
You are currently using the legacy default (true) because `home.stateVersion` is less than "26.05".
To silence this warning set:
programs.mergiraf.enableJujutsuIntegration = true;
''
];
}