[Feature Request] `nushell` integration

[MarvinJWendt]

Checklist

• I have read through the manual page (man fzf)
• I have searched through the existing issues
• For bug reports, I have checked if the bug is reproducible in the latest version of fzf

Output of fzf --version

0.56.3 (v0.56.3)

OS

• Linux
• macOS
• Windows
• Etc.

Shell

• bash
• zsh
• fish

Feature Request

Hi, I am currently switching to nushell as my main shell. I noticed that fzf does not have a nushell integration.
I would like to propose to add a nushell integration, like it is done for zsh, bash and fish.

I really miss the CTRL+t keybind in nushell, as that was my goto way of selecting files in my terminal.

[igor-ramazanov]

@@MarvinJWendt

If you save this in the file and do use <filename>.nu *?

# Dependencies: `fd`, `bat, `rg`, `nufmt`, `tree`.


export-env {
  $env.FZF_ALT_C_COMMAND = "fd --type directory --hidden"
  $env.FZF_ALT_C_OPTS = "--preview 'tree -C {} | head -n 200'"
  $env.FZF_CTRL_T_COMMAND = "fd --type file --hidden"
  $env.FZF_CTRL_T_OPTS = "--preview 'bat --color=always --style=full --line-range=:500 {}' "
  $env.FZF_DEFAULT_COMMAND = "fd --type file --hidden"
}

# Directories
const alt_c = {
    name: fzf_dirs
    modifier: alt
    keycode: char_c
    mode: [emacs, vi_normal, vi_insert]
    event: [
      {
        send: executehostcommand
        cmd: "
          let fzf_alt_c_command = \$\"($env.FZF_ALT_C_COMMAND) | fzf ($env.FZF_ALT_C_OPTS)\";
          let result = nu -c $fzf_alt_c_command;
          cd $result;
        "
      }
    ]
}

# History
const ctrl_r = {
  name: history_menu
  modifier: control
  keycode: char_r
  mode: [emacs, vi_insert, vi_normal]
  event: [
    {
      send: executehostcommand
      cmd: "
        let result = history
          | get command
          | str replace --all (char newline) ' '
          | to text
          | fzf --preview 'printf \'{}\' | nufmt --stdin 2>&1 | rg -v ERROR';
        commandline edit --append $result;
        commandline set-cursor --end
      "
    }
  ]
}

# Files
const ctrl_t =  {
    name: fzf_files
    modifier: control
    keycode: char_t
    mode: [emacs, vi_normal, vi_insert]
    event: [
      {
        send: executehostcommand
        cmd: "
          let fzf_ctrl_t_command = \$\"($env.FZF_CTRL_T_COMMAND) | fzf ($env.FZF_CTRL_T_OPTS)\";
          let result = nu -l -i -c $fzf_ctrl_t_command;
          commandline edit --append $result;
          commandline set-cursor --end
        "
      }
    ]
}

# Update the $env.config
export-env {
  if not ($env.__keybindings_loaded? | default false) {
    $env.__keybindings_loaded = true
    $env.config.keybindings = $env.config.keybindings | append [
      $alt_c
      $ctrl_r
      $ctrl_t
    ]
  }
}

[igor-ramazanov]

I guess, if cleaned up, then it could serve as PR.

Things to consider: remove everything that does not come with the clean nushell installation:

• fd
• rg
• tree
• bat

And delegating as much as possible to the FZF_* env vars.

[imsys]

I tried asking Gemini to use completion.zsh and completion.bash to generate completion.nu. I had to put some pages of the Nushell book in context to at least fix the type errors.

The code runs, but it currently does nothing. If anyone wants to try to get this to work, the code is at:

https://github.com/imsys/fzf/blob/master/shell/completion.nu

[imsys]

I got the **<Tab> completion to somewhat work, but it is still buggy and slow.

[imsys]

It's working, I just need to make tab to fallback when it doesn't find **

echo $env.config.keybindings | where keycode == tab
╭───┬─────────────────┬──────────┬─────────┬───────────────────────────────────────────────────────────┬───────────────────╮
│ # │      name       │ modifier │ keycode │                           event                           │       mode        │
├───┼─────────────────┼──────────┼─────────┼───────────────────────────────────────────────────────────┼───────────────────┤
│ 0 │ completion_menu │ none     │ tab     │ ╭───────┬───────────────────────────────────────────────╮ │ ╭───┬───────────╮ │
│   │                 │          │         │ │       │ ╭───┬──────────┬─────────────────┬──────────╮ │ │ │ 0 │ emacs     │ │
│   │                 │          │         │ │ until │ │ # │   send   │      name       │   edit   │ │ │ │ 1 │ vi_normal │ │
│   │                 │          │         │ │       │ ├───┼──────────┼─────────────────┼──────────┤ │ │ │ 2 │ vi_insert │ │
│   │                 │          │         │ │       │ │ 0 │ menu     │ completion_menu │    ❎    │ │ │ ╰───┴───────────╯ │
│   │                 │          │         │ │       │ │ 1 │ menunext │       ❎        │    ❎    │ │ │                   │
│   │                 │          │         │ │       │ │ 2 │    ❎    │       ❎        │ complete │ │ │                   │
│   │                 │          │         │ │       │ ╰───┴──────────┴─────────────────┴──────────╯ │ │                   │
│   │                 │          │         │ ╰───────┴───────────────────────────────────────────────╯ │                   │
│ 1 │ fzf_completion  │ none     │ tab     │ ╭──────┬────────────────────╮                             │ ╭───┬───────────╮ │
│   │                 │          │         │ │ send │ executehostcommand │                             │ │ 0 │ emacs     │ │
│   │                 │          │         │ │ cmd  │ fzf_tab_handler    │                             │ │ 1 │ vi_normal │ │
│   │                 │          │         │ ╰──────┴────────────────────╯                             │ │ 2 │ vi_insert │ │
│   │                 │          │         │                                                           │ ╰───┴───────────╯ │
╰───┴─────────────────┴──────────┴─────────┴───────────────────────────────────────────────────────────┴───────────────────╯

[imsys]

I got an alternative implementation at:
https://github.com/imsys/fzf/blob/master/shell/completion-external.nu
It uses this document as base:
https://www.nushell.sh/cookbook/external_completers.html

It seems this second approach only works for file searches.
Like:

cat /home/**
nvim /home/**

but not for ls or cd.

[imsys]

It's working quite nice now.
Between the two implementations I mentioned, I recommend the completion-external.nu because it has a fallback, but it has the limitations I mentioned in my previous comment.

The only thing that is not implemented is the completion for some custom commands, like: ssh, scp, telnet, export, unset, kill, etc.

[imsys]

For completion.nu to fully work, it would need:

• nushell/reedline#876 - An event until fallback option.

or

• A way to use Nushell External Completer on commands like cd and ls, since support for it was broken in v0.103.0 ( nushell#15086 ), with a way to it to still fallback to Nushell internal completion_menu

[moshiroi]

I was having issues dropping in the file igor kindly posted - (the combination of zellij + nushell seemed to make fzf functional only outside of zellij). changing how we detect if the keybinding is present fixed it for me.

I pretty much only use fzf for searching through history so here's whats working for me

# History
const ctrl_r = {
  name: history_menu
  modifier: control
  keycode: char_r
  mode: [emacs, vi_insert, vi_normal]
  event: [
    {
      send: executehostcommand
      cmd: "
      let result = history
        | reverse
        | get command
        | str replace --all (char newline) ' '
        | to text
        | fzf --height 40% --reverse --border;
      commandline edit --append $result;
      commandline set-cursor --end
      "
    }
  ]
}

# Update the $env.config
export-env {
  # Only append if not already present (check by name)
  let has_history_menu = $env.config.keybindings | any {|kb| $kb.name == "history_menu"}
  
  if not $has_history_menu {
    $env.config.keybindings = $env.config.keybindings | append [
      $ctrl_r
    ]
  }
}

[sim590]

For me, the file suggested by @imsys didn't work. I described my issue here. I decided to submit 2 PRs to fix those issues:

• shell/completion-external.nu: use command flag for optional closure imsys/fzf#3
• shell/completion-external.nu: remove bad "return" calls imsys/fzf#4

After applying those, everything worked fine. I also supplied a PR for implementing completion for pass in imsys#2.

Hopefully, this can be merged by @imsys.

After that, I don't know what would be missing for a first iteration to be merged in upstream fzf repo ?

[imsys]

Hey @sim590, I haven’t touched this code in a while. There are three different implementations: completion-bind.nu, completion-external.nu, and completion-menu.nu.

I think it would be best to upstream only completion-external.nu and key-bindings.nu.

I’ve been focused on another project, and I’m also trying to lower my ADHD medication, so I went ahead and accepted your pull requests without testing them.

If you’re willing to open the pull request to merge upstream, I’d really appreciate it. It would also be good to review the changes proposed by @moshiroi. #4122 (comment)

[sim590]

@imsys Of course. I'll look at the bindings part, merge all we have that make sense and try to formulate a proper PR for upstream. Thanks for the initial work. I'll update this issue in the future.