Fish bind mode not working as expected after update

[cpplain]

I configured posh to display colors and text specific to the fish bind mode. In the past, the changes have been immediate when entering a new mode (e.g., hitting esc or I). Sometime this week, after I applied an update, the text and color changes would only take effect after hitting enter. Unfortunately, I don't know which posh version I was running prior or which version broke prior functionality. There don't appear to be any recent changes to WezTerm or fish, so I'm leaning towards a something changing in posh. Any help would be appreciated.

Current terminal, shell, and prompt versions:

• wezterm 20240203-110809-5046fc22
• fish 3.7.1
• oh-my-posh 23.3.1

# omp.toml

"$schema" = "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json"
version = 2
final_space = false

# Catppuccin Palette

[palette]
rosewater = "#f5e0dc"
flamingo = "#f2cdcd"
pink = "#f5c2e7"
mauve = "#cba6f7"
red = "#f38ba8"
maroon = "#eba0ac"
peach = "#fab387"
yellow = "#f9e2af"
green = "#a6e3a1"
teal = "#94e2d5"
sky = "#89dceb"
sapphire = "#74c7ec"
blue = "#89b4fa"
lavender = "#b4befe"
text = "#cdd6f4"
subtext1 = "#bac2de"
subtext0 = "#a6adc8"
overlay2 = "#9399b2"
overlay1 = "#7f849c"
overlay0 = "#6c7086"
surface2 = "#585b70"
surface1 = "#45475a"
surface0 = "#313244"
base = "#1e1e2e"
mantle = "#181825"
crust = "#11111b"

#
# Left Block
#

[[blocks]]
type = "prompt"
alignment = "left"
newline = true

# Mode

[[blocks.segments]]
type = "text"
style = "plain"
foreground = "p:base"
template = """\
    <b>\
    {{ if eq \"default\" .Env.OMP_BIND_MODE }}<,p:blue> NORMAL </>{{ end }}\
    {{ if eq \"insert\" .Env.OMP_BIND_MODE }}<,p:green> INSERT </>{{ end }}\
    {{ if eq \"replace\" .Env.OMP_BIND_MODE }}<,p:red> REPLACE </>{{ end }}\
    {{ if eq \"replace_one\" .Env.OMP_BIND_MODE }}<,p:blue> NORMAL </>{{ end }}\
    {{ if eq \"visual\" .Env.OMP_BIND_MODE }}<,p:mauve> VISUAL </>{{ end }}\
    </b>"""

# Git

[[blocks.segments]]
type = "text"
style = "plain"
foreground_templates = [
  "{{ if eq \"default\" .Env.OMP_BIND_MODE }}p:blue{{ end }}",
  "{{ if eq \"insert\" .Env.OMP_BIND_MODE }}p:green{{ end }}",
  "{{ if eq \"replace\" .Env.OMP_BIND_MODE }}p:red{{ end }}",
  "{{ if eq \"replace_one\" .Env.OMP_BIND_MODE }}p:blue{{ end }}",
  "{{ if eq \"visual\" .Env.OMP_BIND_MODE }}p:mauve{{ end }}",
]
background = "p:surface0"
template = " {{ .Env.OMP_GIT_BRANCH }} "

# Session 

[[blocks.segments]]
type = "session"
style = "plain"
foreground = "p:text"
template = " {{ if .SSHSession }}{{ .UserName }}@{{ .HostName }}{{ end }}"

# Path

[[blocks.segments]]
type = "path"
style = "plain"
foreground = "p:text"
background = "p:mantle"
template = " {{ .Path }} "

[blocks.segments.properties]
style = "full"

#
# Right Block
#

[[blocks]]
type = "prompt"
alignment = "right"
filler = "<,p:mantle> </>"

# Shell

[[blocks.segments]]
type = "text"
style = "plain"
foreground = "p:text"
background = "p:mantle"
template = " {{ .Shell }} "

# Execution Time

[[blocks.segments]]
type = "executiontime"
style = "plain"
foreground = "p:base"
background_templates = [
  "{{ if eq \"default\" .Env.OMP_BIND_MODE }}p:blue{{ end }}",
  "{{ if eq \"insert\" .Env.OMP_BIND_MODE }}p:green{{ end }}",
  "{{ if eq \"replace\" .Env.OMP_BIND_MODE }}p:red{{ end }}",
  "{{ if eq \"replace_one\" .Env.OMP_BIND_MODE }}p:blue{{ end }}",
  "{{ if eq \"visual\" .Env.OMP_BIND_MODE }}p:mauve{{ end }}",
]
template = " <b>{{ .FormattedMs }}</b> "

[blocks.segments.properties]
style = "round"
always_enabled = true

#
# Prompt
#

[[blocks]]
type = "prompt"
alignment = "left"
newline = true

[[blocks.segments]]
type = "status"
style = "plain"
foreground = "p:text"
foreground_templates = ["{{ if gt .Code 0 }}p:red{{ end }}"]
template = ": "

[blocks.segments.properties]
always_enabled = true

[transient_prompt]
foreground = "p:text"
template = ": "

# fish/conf.d/omp.fish

oh-my-posh init fish --config ~/.config/omp.toml | source

function set_poshcontext --no-scope-shadowing
    set -e OMP_BIND_MODE
    set -e OMP_GIT_BRANCH

    set -gx OMP_BIND_MODE $fish_bind_mode

    if git branch --show-current 2>/dev/null | read -l git_branch
        set -gx OMP_GIT_BRANCH $git_branch
    end
end

[JanDeDobbeleer]

@cpplain we changed the way the prompt is re-rendered to only do so when an actual change occurs. So highly likely this has something to do with it, but that's by design to be more efficient. That's why set_poshcontext only runs at that moment.

[cpplain]

@JanDeDobbeleer does this mean the prior functionality is gone for good?

[JanDeDobbeleer]

@cpplain behavior, yes. Unless @lewis-yeung has other insights here.

[lewis-yeung]

@cpplain For your use case, here is a simple workaround:

function repaint_on_bind_mode_change --on-variable fish_bind_mode
    if test $fish_bind_mode != paste
        set _omp_new_prompt true
        commandline --function repaint
    end
end

Despite this, I do NOT recommend doing so because:

• $_omp_new_prompt is for internal use only and its availability is not guaranteed in future versions of OMP;
• to some extent it hacks the prompt repainting logic, which may lead to underlying unexpected behavior in other areas.

[JanDeDobbeleer]

@cpplain we strive for customer satisfaction in this project.

[cpplain]

@JanDeDobbeleer you definitely succeeded. I was not expecting a change given how specific to me the use case likely is.

[lewis-yeung]

Anyway, we're supposed to ensure the use case since it is well described in the documentation of Fish.

[cpplain]

@JanDeDobbeleer @lewis-yeung I updated my config to match docs after the 23.6 release. Everything is working as I expect. Thank you again for addressing this so quickly.

doc ref: https://ohmyposh.dev/docs/faq#fish-display-current-bind-vim-mode

[cpplain]

Accurately displaying fish bind mode as it changes is a must for me. I do appreciate you need to make changes to the project that will help the majority of users (i.e., when to re-render). Unfortunately for me, this means I will not be able to continue using oh-my-posh. I am disappointed as I found oh-my-posh to be a far better alternative than the other prompts I've tried. I wish the project continued success in the future.

UPDATE 2024-08-01 17:51 UTC
Seems there is a viable temporary workaround and possibly a long-term supported solution. See #5393 (comment)