Unverified Commit 8978af6b authored by Basti's avatar Basti Committed by GitHub
Browse files

Merge pull request #303213 from SuperSandro2000/fzf-followup

nixos/fzf: bring back keybindings and completion option removed in #298692
parents fc019034 15ed0d21
Loading
Loading
Loading
Loading
+4 −4
Original line number Diff line number Diff line
@@ -2,11 +2,11 @@

Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard `share` directory location. This is why a bunch `PACKAGE-share` scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following:

- `sk` : `sk-share`
- `fzf` : `fzf-share`

E.g. `sk` can then be used in the `.bashrc` like this:
E.g. `fzf` can then be used in the `.bashrc` like this:

```bash
source "$(sk-share)/completion.bash"
source "$(sk-share)/key-bindings.bash"
source "$(fzf-share)/completion.bash"
source "$(fzf-share)/key-bindings.bash"
```
+1 −1
Original line number Diff line number Diff line
@@ -79,7 +79,7 @@ In addition to numerous new and updated packages, this release has the following

- [frigate](https://frigate.video), an open source NVR built around real-time AI object detection. Available as [services.frigate](#opt-services.frigate.enable).

- [fzf](https://github.com/junegunn/fzf), a command line fuzzyfinder. Available as [programs.fzf](#opt-programs.fzf.enable).
- [fzf](https://github.com/junegunn/fzf), a command line fuzzyfinder. Available as [programs.fzf](#opt-programs.fzf.fuzzyCompletion).

- [gemstash](https://github.com/rubygems/gemstash), a RubyGems.org cache and private gem server. Available as [services.gemstash](#opt-services.gemstash.enable).

+0 −2
Original line number Diff line number Diff line
@@ -328,8 +328,6 @@ The pre-existing [services.ankisyncd](#opt-services.ankisyncd.enable) has been m

- `xxd` has been moved from `vim` default output to its own output to reduce closure size. The canonical way to reference it across all platforms is `unixtools.xxd`.

- `programs.fzf.keybindings` and `programs.fzf.fuzzyCompletion` got replaced by `programs.fzf.enable` as shell-completion is included in the fzf-binary now there is no easy option to load completion and keybindings separately. Please consult fzf-documentation on how to configure/disable certain keybindings.

- The `stalwart-mail` package has been updated to v0.5.3, which includes [breaking changes](https://github.com/stalwartlabs/mail-server/blob/v0.5.3/UPGRADING.md).

- `services.zope2` has been removed as `zope2` is unmaintained and was relying on Python2.
+22 −30
Original line number Diff line number Diff line
{ pkgs, config, lib, ... }:

with lib;

let
  cfg = config.programs.fzf;

in
{
  imports = [
    (lib.mkRemovedOptionModule [ "programs" "fzf" "keybindings" ] ''
      Use "programs.fzf.enable" instead, due to fzf upstream-change it's not possible to load shell-completion and keybindings separately.
      If you want to change/disable certain keybindings please check the fzf-documentation.
    '')
    (lib.mkRemovedOptionModule [ "programs" "fzf" "fuzzyCompletion" ] ''
      Use "programs.fzf.enable" instead, due to fzf upstream-change it's not possible to load shell-completion and keybindings separately.
      If you want to change/disable certain keybindings please check the fzf-documentation.
    '')
  ];

  options = {
    programs.fzf.enable = mkEnableOption (mdDoc "fuzzy completion with fzf and keybindings");
    programs.fzf = {
      fuzzyCompletion = lib.mkEnableOption (lib.mdDoc "fuzzy completion with fzf");
      keybindings = lib.mkEnableOption (lib.mdDoc "fzf keybindings");
    };
  };

  config = mkIf cfg.enable {
    environment.systemPackages = [ pkgs.fzf ];

    programs.bash.interactiveShellInit = ''
      eval "$(${getExe pkgs.fzf} --bash)"
    '';
  config = lib.mkIf (cfg.keybindings || cfg.fuzzyCompletion) {
    environment.systemPackages = lib.mkIf (cfg.keybindings || cfg.fuzzyCompletion) [ pkgs.fzf ];

    programs.fish.interactiveShellInit = ''
      ${getExe pkgs.fzf} --fish | source
    programs = {
      bash.interactiveShellInit = lib.optionalString cfg.fuzzyCompletion ''
        source ${pkgs.fzf}/share/fzf/completion.bash
      '' + lib.optionalString cfg.keybindings ''
        source ${pkgs.fzf}/share/fzf/key-bindings.bash
      '';

    programs.zsh = {
      interactiveShellInit = optionalString (!config.programs.zsh.ohMyZsh.enable) ''
        eval "$(${getExe pkgs.fzf} --zsh)"
      '';
      zsh = {
        interactiveShellInit = lib.optionalString (!config.programs.zsh.ohMyZsh.enable)
        (lib.optionalString cfg.fuzzyCompletion ''
          source ${pkgs.fzf}/share/fzf/completion.zsh
        '' + lib.optionalString cfg.keybindings ''
          source ${pkgs.fzf}/share/fzf/key-bindings.zsh
        '');

      ohMyZsh.plugins = mkIf (config.programs.zsh.ohMyZsh.enable) [ "fzf" ];
        ohMyZsh.plugins = lib.mkIf config.programs.zsh.ohMyZsh.enable [ "fzf" ];
      };
    };
  };

  meta.maintainers = with maintainers; [ laalsaas ];
  meta.maintainers = with lib.maintainers; [ laalsaas ];
}
+18 −0
Original line number Diff line number Diff line
{ lib
, buildGoModule
, fetchFromGitHub
, runtimeShell
, installShellFiles
, bc
, ncurses
@@ -55,6 +56,23 @@ buildGoModule rec {
    install -D plugin/* -t $out/share/vim-plugins/${pname}/plugin
    mkdir -p $out/share/nvim
    ln -s $out/share/vim-plugins/${pname} $out/share/nvim/site

    # Install shell integrations
    install -D shell/* -t $out/share/fzf/
    install -D shell/key-bindings.fish $out/share/fish/vendor_functions.d/fzf_key_bindings.fish
    mkdir -p $out/share/fish/vendor_conf.d
    cat << EOF > $out/share/fish/vendor_conf.d/load-fzf-key-bindings.fish
      status is-interactive; or exit 0
      fzf_key_bindings
    EOF

    cat <<SCRIPT > $out/bin/fzf-share
    #!${runtimeShell}
    # Run this script to find the fzf shared folder where all the shell
    # integration scripts are living.
    echo $out/share/fzf
    SCRIPT
    chmod +x $out/bin/fzf-share
  '';

  passthru.tests.version = testers.testVersion {