Add use-fzf-default-opts

[PrayagS]

Ref: #475

0b49f3e introduces a change that makes the plugin ignore FZF_DEFAULT_OPTS by default.

This commit adds a flag to disable this behavior.

[pablospe]

I was wondering if fzf_default_opts couldn't be set outside like this:
zstyle ':fzf-tab:*' fzf-default-opts $FZF_DEFAULT_OPTS
?

I that case you could get ride off the use_fzf_default_opts option.

[PrayagS]

Yeah I was going for a quick change so didn't try that. I thought zstyle might parse things differently and lead to unintended behaviors.

Let me try that and get back here.

[PrayagS]

Ah I remember it now. Since FZF_DEFAULT_OPTS is a bunch of flags, we need to pass it as such and not as an environment variable.

And fzf-flags already exists in the plugin. But when I tried setting that equal to the flags in FZF_DEFAULT_OPTS (see below), it wasn't working. I think the reason is the same as what I mentioned in #475 (comment).

# this converts the string to a string array which is expected by fzf-flags.
export parsed_fzf_default_opts=(${=FZF_DEFAULT_OPTS})

zstyle ':fzf-tab:*' fzf-flags $parsed_fzf_default_opts

[pablospe]

Your suggestion doesn't seem to be working for my case:

export FZF_DEFAULT_OPTS="          \
  --exact                          \
  --height ${FZF_TMUX_HEIGHT:-30%} \
  --layout=reverse                 \
  --info=hidden                    \
  --prompt='$  '                   \
  --pointer='=>'                   \
  --marker='+'                     \
  --cycle                          \
  --select-1                       \
  --color=dark                     \
  --bind '?:toggle-preview,ctrl-a:select-all,ctrl-d:half-page-down,ctrl-u:half-page-up,ctrl-l:clear-query,home:first,end:last,enter:accept-non-empty,alt-down:down,alt-up:up,right:accept-non-empty,alt-right:accept-non-empty,alt-left:close,left:close' \
  --color='fg:-1,bg:-1,hl:#fb8aa4,fg+:-1,bg+:-1,hl+:#55E579' \
  --color='info:#af87ff,prompt:#fb8aa4,pointer:#55E579,marker:#55E579,spinner:#55E579'
"

I think the --height ${FZF_TMUX_HEIGHT:-30%} is not correctly handle.

[Aloxaf]

@pablospe can you try this?

zstyle ':fzf-tab:*' fzf-flags ${(Q)${(Z:nC:)FZF_DEFAULT_OPTS}}

[pablospe]

This is magic! It is working, thanks!

[PrayagS]

These are my flags,

# Set fzf options
export FZF_DEFAULT_OPTS=$FZF_DEFAULT_OPTS'
    --color=bg:#1b1b1b
    --color=preview-bg:#1b1b1b
    --color=hl+:#fb4934
    --color=gutter:#1b1b1b
    --color=pointer:#f9f5d7,marker:#f9f5d7
    --color=info:#ebdbb2,spinner:#f9f5d7
    --color=query:#ebdbb2,prompt:#ebdbb2
    --color=border:#ebdbb2
    --border="rounded" --prompt="> "
    --marker="" --pointer="->" --layout="reverse"
'

While echo ${(Q)${(Z:nC:)FZF_DEFAULT_OPTS}} looks as expected, when I try to open fzf-tab, it fails with an eval error.

[pablospe]

Adding @Aloxaf for awareness. I think it is good to add an option so the user can decide about this behavior but taking care of leaving a safe default, as this PR proposes.

[Aloxaf]

I think we should warn user that this may cause unexpected behavior.

[pablospe]

@PrayagS I think you can mention here there are other plugins that overrides the value of fzf-flags directly, creating bugs.

Now I was wondering if overriding the fzf-flags is the right thing to do for an external plugin, it should do something like: fzf-flags = fzf-flags + <extra_things>?

[PrayagS]

@Aloxaf Updated the README. Please review 380daee (#479).

@pablospe My comment on Freed-Wu/fzf-tab-source causing a conflict is a hunch. Because when I was reviewing its code, it overrides it specifically for a completion type (see https://github.com/Freed-Wu/fzf-tab-source/blob/aabde06d1e82b839a350a8a1f5f5df3d069748fc/fzf-tab-source.plugin.zsh#L31). The more likely reason for it to not work could be just a parsing issue with the flags.

[Aloxaf]

Umm, quite reasonable.

zstyle ':fzf-tab:*' fzf-flags ${(Q)${(Z:nC:)FZF_DEFAULT_OPTS}} or zstyle ':fzf-tab:*' use-fzf-default-opts yes, which one do you prefer?

[pablospe]

Umm, quite reasonable.

zstyle ':fzf-tab:*' fzf-flags ${(Q)${(Z:nC:)FZF_DEFAULT_OPTS}} or zstyle ':fzf-tab:*' use-fzf-default-opts yes, which one do you prefer?

I don't have a strong preference:
zstyle ':fzf-tab:*' fzf-flags ${(Q)${(Z:nC:)FZF_DEFAULT_OPTS}}
doesn't touch the code, only the documentation. Although, it is more complicated to understand, and my guess it is more susceptible to errors (maybe something in the FZF_DEFAULT_OPTS will break the parsing). In the other hand, the 2nd option seems more elegant, there is no parsing and self-explanatory: use-fzf-default-opts yes. Notice that implementing the 2nd solution still allows to do use the first one.

[PrayagS]

Umm, quite reasonable.

zstyle ':fzf-tab:*' fzf-flags ${(Q)${(Z:nC:)FZF_DEFAULT_OPTS}} or zstyle ':fzf-tab:*' use-fzf-default-opts yes, which one do you prefer?

In reference to #479 (comment), if the solution that you shared is dependent on how flags are written and parsed, it is highly likely to break frequently as more users start using it. It could also break when fzf adds some new flag.

So I think adding an explicit setting sounds more reasonable.