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

fzf: warn on conflicting ctrl-r bindings

Browse source 
Detect active fzf and history-manager Ctrl-R bindings by their configured values, warn with the winning precedence, and let the normal binding options silence the warning.
This commit is contained in:
Austin Horstman 2026-07-01 19:19:16 -05:00
parent f15a4bf065
commit 0396024ea5
7 changed files with 233 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

97
modules/programs/fzf.nix
View file

@ -281,13 +281,98 @@ in
in
mkIf cfg.enable {
warnings =
lib.optional (cfg.historyWidget.command != null && lib.versionOlder cfg.package.version "0.66.0")
''
`programs.fzf.historyWidget.command` defined in ${lib.showFiles options.programs.fzf.historyWidget.command.files} requires fzf 0.66.0 or greater.
let
shellIntegrationOptions = {
bash = "enableBashIntegration";
fish = "enableFishIntegration";
nushell = "enableNushellIntegration";
zsh = "enableZshIntegration";
};
The configured FZF_CTRL_R_COMMAND value will be ignored by older fzf
versions.
'';
integrationCtrlRActive =
shell: programConfig:
config.programs.${shell}.enable
&& programConfig.enable
&& programConfig.${shellIntegrationOptions.${shell}};
fzfCtrlRActive =
shell:
let
shellCommand = cfg.historyWidget.${shell}.command;
effectiveCommand = if shellCommand != null then shellCommand else cfg.historyWidget.command;
in
integrationCtrlRActive shell cfg && effectiveCommand != "";
atuinCtrlRActive =
shell:
integrationCtrlRActive shell config.programs.atuin
&& !(builtins.elem "--disable-ctrl-r" config.programs.atuin.flags);
mcflyCtrlRActive = shell: shell != "nushell" && integrationCtrlRActive shell config.programs.mcfly;
ctrlRConflictShells = builtins.filter (
shell: fzfCtrlRActive shell && (atuinCtrlRActive shell || mcflyCtrlRActive shell)
) shells;
showOptionFiles = option: lib.showFiles option.files;
fzfCtrlRDefinition =
shell:
if cfg.historyWidget.${shell}.command != null then
"`programs.fzf.historyWidget.${shell}.command` defined in ${
showOptionFiles options.programs.fzf.historyWidget.${shell}.command
}"
else if cfg.historyWidget.command != null then
"`programs.fzf.historyWidget.command` defined in ${showOptionFiles options.programs.fzf.historyWidget.command}"
else
"`programs.fzf.enable` defined in ${showOptionFiles options.programs.fzf.enable}";
atuinCtrlRDefinition =
if config.programs.atuin.flags != [ ] then
"`programs.atuin.flags` defined in ${showOptionFiles options.programs.atuin.flags}"
else
"`programs.atuin.enable` defined in ${showOptionFiles options.programs.atuin.enable}";
mcflyCtrlRDefinition = "`programs.mcfly.enable` defined in ${showOptionFiles options.programs.mcfly.enable}";
ctrlRConflictDefinitions = lib.concatStringsSep "\n" (
lib.concatMap (
shell:
[
" ${shell}:"
" ${fzfCtrlRDefinition shell}"
]
++ lib.optionals (atuinCtrlRActive shell) [ " ${atuinCtrlRDefinition}" ]
++ lib.optionals (mcflyCtrlRActive shell) [ " ${mcflyCtrlRDefinition}" ]
) ctrlRConflictShells
);
in
lib.optional (cfg.historyWidget.command != null && lib.versionOlder cfg.package.version "0.66.0") ''
`programs.fzf.historyWidget.command` defined in ${lib.showFiles options.programs.fzf.historyWidget.command.files} requires fzf 0.66.0 or greater.
The configured FZF_CTRL_R_COMMAND value will be ignored by older fzf
versions.
''
++ lib.optional (ctrlRConflictShells != [ ]) ''
programs.fzf and a history manager both configure Ctrl-R for ${lib.concatStringsSep ", " ctrlRConflictShells}.
Definitions:
${ctrlRConflictDefinitions}
The history manager integration is sourced after fzf and owns Ctrl-R.
Choose which integration should own Ctrl-R.
To keep the history manager on Ctrl-R, disable fzf's binding:
programs.fzf.historyWidget.command = "";
or disable it for one shell:
programs.fzf.historyWidget.${builtins.head ctrlRConflictShells}.command = "";
To keep fzf on Ctrl-R with Atuin, disable Atuin's Ctrl-R binding:
programs.atuin.flags = [ "--disable-ctrl-r" ];
McFly has no Ctrl-R-only option in Home Manager. Disable McFly's
shell integration for that shell if fzf should own Ctrl-R.
To use another key, disable one default Ctrl-R binding and add a
shell-specific key binding in your shell configuration.
'';
assertions = [
{

2
tests/modules/programs/atuin/nushell-fzf-order.nix
View file

@ -22,6 +22,7 @@
fzf = {
enable = true;
enableNushellIntegration = true;
historyWidget.nushell.command = "";
package = config.lib.test.mkStubPackage {
name = "fzf";
@ -51,6 +52,7 @@
''
assertFileExists "${nushellConfigFile}"
assertFileContent "$(normalizeStorePaths "${nushellConfigFile}")" ${builtins.toFile "nushell-fzf-atuin-order-expected.nu" ''
$env.FZF_CTRL_R_COMMAND = ""
source /nix/store/00000000000000000000000000000000-nushell-fzf-integration.nu
source /nix/store/00000000000000000000000000000000-atuin-nushell-config.nu

27
tests/modules/programs/fzf/ctrl-r-conflict-atuin-disabled.nix Normal file
View file

@ -0,0 +1,27 @@
{ config, ... }:
{
programs = {
atuin = {
enable = true;
enableZshIntegration = true;
flags = [ "--disable-ctrl-r" ];
package = config.lib.test.mkStubPackage { name = "atuin"; };
};
fzf = {
enable = true;
enableZshIntegration = true;
package = config.lib.test.mkStubPackage {
name = "fzf";
version = "0.73.0";
};
};
zsh.enable = true;
};
nmt.script = ''
assertFileExists home-files/.zshrc
'';
}

27
tests/modules/programs/fzf/ctrl-r-conflict-fzf-disabled.nix Normal file
View file

@ -0,0 +1,27 @@
{ config, ... }:
{
programs = {
atuin = {
enable = true;
enableZshIntegration = true;
package = config.lib.test.mkStubPackage { name = "atuin"; };
};
fzf = {
enable = true;
enableZshIntegration = true;
historyWidget.command = "";
package = config.lib.test.mkStubPackage {
name = "fzf";
version = "0.73.0";
};
};
zsh.enable = true;
};
nmt.script = ''
assertFileExists home-files/.zshrc
'';
}

27
tests/modules/programs/fzf/ctrl-r-conflict-per-shell-disabled.nix Normal file
View file

@ -0,0 +1,27 @@
{ config, ... }:
{
programs = {
atuin = {
enable = true;
enableZshIntegration = true;
package = config.lib.test.mkStubPackage { name = "atuin"; };
};
fzf = {
enable = true;
enableZshIntegration = true;
historyWidget.zsh.command = "";
package = config.lib.test.mkStubPackage {
name = "fzf";
version = "0.73.0";
};
};
zsh.enable = true;
};
nmt.script = ''
assertFileExists home-files/.zshrc
'';
}

55
tests/modules/programs/fzf/ctrl-r-conflict-warning.nix Normal file
View file

@ -0,0 +1,55 @@
{
config,
lib,
options,
...
}:
{
programs = {
atuin = {
enable = true;
enableZshIntegration = true;
package = config.lib.test.mkStubPackage { name = "atuin"; };
};
fzf = {
enable = true;
enableZshIntegration = true;
package = config.lib.test.mkStubPackage {
name = "fzf";
version = "0.73.0";
};
};
zsh.enable = true;
};
test.asserts.warnings.expected = [
''
programs.fzf and a history manager both configure Ctrl-R for zsh.
Definitions:
zsh:
`programs.fzf.enable` defined in ${lib.showFiles options.programs.fzf.enable.files}
`programs.atuin.enable` defined in ${lib.showFiles options.programs.atuin.enable.files}
The history manager integration is sourced after fzf and owns Ctrl-R.
Choose which integration should own Ctrl-R.
To keep the history manager on Ctrl-R, disable fzf's binding:
programs.fzf.historyWidget.command = "";
or disable it for one shell:
programs.fzf.historyWidget.zsh.command = "";
To keep fzf on Ctrl-R with Atuin, disable Atuin's Ctrl-R binding:
programs.atuin.flags = [ "--disable-ctrl-r" ];
McFly has no Ctrl-R-only option in Home Manager. Disable McFly's
shell integration for that shell if fzf should own Ctrl-R.
To use another key, disable one default Ctrl-R binding and add a
shell-specific key binding in your shell configuration.
''
];
nmt.script = ''
assertFileExists home-files/.zshrc
'';
}

4
tests/modules/programs/fzf/default.nix
View file

@ -1,5 +1,9 @@
{
fzf-bash-widget-overrides = ./bash-widget-overrides.nix;
fzf-ctrl-r-conflict-atuin-disabled = ./ctrl-r-conflict-atuin-disabled.nix;
fzf-ctrl-r-conflict-fzf-disabled = ./ctrl-r-conflict-fzf-disabled.nix;
fzf-ctrl-r-conflict-per-shell-disabled = ./ctrl-r-conflict-per-shell-disabled.nix;
fzf-ctrl-r-conflict-warning = ./ctrl-r-conflict-warning.nix;
fzf-disabled = ./disabled.nix;
fzf-options = ./all-options.nix;
fzf-bash-integration = ./bash-integration.nix;