Make FzF options configurable

[Nelyah]

This adds the ability to configure the FzF options used by the
NewNoteFilter.

Here are the sources for the FzF options, in order of precedence (first
precedes the second):

1. tool.fzf-additional-args in the note directory config file
2. Default arguments set by zk in internal/adapter/fzf/fzf.go
3. Environment variable FZF_DEFAULT_OPTS

This should solve #137

Let me know if I can improve on it. As I mentioned in the issue those are my first lines of Go so it's still a bit of a struggle.

[mickael-menu]

Thank you for tackling this, I appreciate it!

A few comments:

• I found an issue while testing: if any of fzf-additional-args or FZF_DEFAULT_OPTS are not set or empty, it will error out with:

  $ zk list -i
  unknown option:
  zk: error: failed to filter interactively the output with fzf, try again without --interactive or make sure you have a working fzf installation: exit status 2

  I think using shellquote like described in my other comment should solve the problem.

• I don't think you need to add FZF_DEFAULT_OPTS manually, it should be handled automatically by fzf. I tried FZF_DEFAULT_OPTS="--border" zk list -i from the main branch and it works.

• I would prefer using fzf-options / FzfOptions instead of fzf-additional-args, to make it closer to FZF_DEFAULT_OPTS.

• Some of the zk hard-coded options could actually be part of the default value for fzf-options, when unset. Some can't be unset by additional arguments (like --no-hscroll) and most of them are tuned to my taste. I suggest:

  • Keeping only the essential hard-coded options: --delimiter and --ansi.
  • Adding to the default value of fzf-options: --tiebreak begin --exact --tabstop 4 --height 100% --layout reverse --no-hscroll --color hl:-1,hl+:-1 --preview-window wrap
    • Look for LineTemplate.OrString(defaultLineTemplate).String() for an example of handling a default value for an option.

Thanks again!

[Nelyah]

Thank you very much for the detailed @mickael-menu! I'm sorry I haven't had much time these past few weeks to really get to this, but I haven't forgotten about it :)

[mickael-menu]

@Nelyah No problem, I can relate ;)

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity.

[megalithic]

Hello friends; just checking in to see if this still has some traction/working towards it. Hope you are all well during these crazy times.

Are there work-arounds for the fzf key binding overrides in the meantime?

[mickael-menu]

Hi @megalithic, I intend to finish the work eventually but I've been really busy the past few weeks so I'm not sure when I'll find the time yet.

[Nelyah]

Hi, apologies for letting this without update for so long. If you do have the time now to get to it, feel free to. Otherwise I will also try to finish it when I get the time.

[megalithic]

whew, glad it's not officially stale anymore. 🙏

[mickael-menu]

Thank you @Nelyah for kickstarting this PR!

@megalithic I changed the default key binding to create a new note to Ctrl-E to avoid conflicts. But you can choose a different one with:

[tool]
fzf-bind-new = "Ctrl-C"

I plan to make a new release very soon.