mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2024-12-28 12:29:40 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(fish): support on-demand prompt re-rendering
Some checks failed
Code QL / code-ql (push) Waiting to run
Details
Release / changelog (push) Waiting to run
Details
Release / artifacts (push) Blocked by required conditions
Details
Azure Static Web Apps CI/CD / Build and Deploy (push) Has been cancelled
Details

Browse source
This commit is contained in:
L. Yeung 2024-08-06 20:37:51 +08:00 committed by Jan De Dobbeleer
parent 9bcc084787
commit 2f5f59b5d2
2 changed files with 37 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
src/shell/scripts/omp.fish
View file

@ -5,7 +5,7 @@ set --export POSH_PID $fish_pid
set --export CONDA_PROMPT_MODIFIER false set --export CONDA_PROMPT_MODIFIER false
set --global _omp_tooltip_command '' set --global _omp_tooltip_command ''
set --global _omp_current_rprompt '' set --global _omp_current_rprompt ''
set --global _omp_transient false set --global _omp_transient 0
set --global _omp_executable ::OMP:: set --global _omp_executable ::OMP::
set --global _omp_ftcs_marks 0 set --global _omp_ftcs_marks 0
@ -13,7 +13,7 @@ set --global _omp_transient_prompt 0
set --global _omp_prompt_mark 0 set --global _omp_prompt_mark 0
# We use this to avoid unnecessary CLI calls for prompt repaint. # We use this to avoid unnecessary CLI calls for prompt repaint.
set --global _omp_new_prompt true set --global _omp_new_prompt 1
# template function for context loading # template function for context loading
function set_poshcontext function set_poshcontext
@ -29,11 +29,11 @@ function fish_prompt
# commandline --function repaint does not do this # commandline --function repaint does not do this
# see https://github.com/fish-shell/fish-shell/issues/8418 # see https://github.com/fish-shell/fish-shell/issues/8418
printf \e\[0J printf \e\[0J
if test "$_omp_transient" = true if test "$_omp_transient" = 1
$_omp_executable print transient --shell fish --status $_omp_status_cache --pipestatus="$_omp_pipestatus_cache" --execution-time $_omp_duration --stack-count $_omp_stack_count --shell-version $FISH_VERSION --no-status=$_omp_no_exit_code $_omp_executable print transient --shell fish --status $_omp_status_cache --pipestatus="$_omp_pipestatus_cache" --execution-time $_omp_duration --stack-count $_omp_stack_count --shell-version $FISH_VERSION --no-status=$_omp_no_exit_code
return return
end end
if test "$_omp_new_prompt" = false if test "$_omp_new_prompt" = 0
echo -n "$_omp_current_prompt" echo -n "$_omp_current_prompt"
return return
end end
@ -44,13 +44,13 @@ function fish_prompt
set --global _omp_no_exit_code false set --global _omp_no_exit_code false
# check if variable set, < 3.2 case # check if variable set, < 3.2 case
if set --query _omp_last_command; and test -z "$_omp_last_command" if set --query _omp_last_command && test -z "$_omp_last_command"
set _omp_duration 0 set _omp_duration 0
set _omp_no_exit_code true set _omp_no_exit_code true
end end
# works with fish >=3.2 # works with fish >=3.2
if set --query _omp_last_status_generation; and test "$_omp_last_status_generation" = "$status_generation" if set --query _omp_last_status_generation && test "$_omp_last_status_generation" = "$status_generation"
set _omp_duration 0 set _omp_duration 0
set _omp_no_exit_code true set _omp_no_exit_code true
else if test -z "$_omp_last_status_generation" else if test -z "$_omp_last_status_generation"
@ -82,18 +82,18 @@ function fish_prompt
end end
function fish_right_prompt function fish_right_prompt
if test "$_omp_transient" = true if test "$_omp_transient" = 1
set _omp_transient false set _omp_transient 0
return return
end end
# Repaint an existing right prompt. # Repaint an existing right prompt.
if test "$_omp_new_prompt" = false if test "$_omp_new_prompt" = 0
echo -n "$_omp_current_rprompt" echo -n "$_omp_current_rprompt"
return return
end end
set _omp_new_prompt false set _omp_new_prompt 0
set --global _omp_current_rprompt ($_omp_executable print right --shell fish --status $_omp_status_cache --pipestatus="$_omp_pipestatus_cache" --execution-time $_omp_duration --stack-count $_omp_stack_count --shell-version $FISH_VERSION --no-status=$_omp_no_exit_code | string join '') set --global _omp_current_rprompt ($_omp_executable print right --shell fish --status $_omp_status_cache --pipestatus="$_omp_pipestatus_cache" --execution-time $_omp_duration --stack-count $_omp_stack_count --shell-version $FISH_VERSION --no-status=$_omp_no_exit_code | string join '')
echo -n "$_omp_current_rprompt" echo -n "$_omp_current_rprompt"
@ -112,25 +112,25 @@ function _omp_preexec --on-event fish_preexec
end end
# perform cleanup so a new initialization in current session works # perform cleanup so a new initialization in current session works
if test -n (bind \r --user 2>/dev/null | string match -e _omp_enter_key_handler) if bind \r --user 2>/dev/null | string match -q -e _omp_enter_key_handler
bind -e \r -M default bind -e \r -M default
bind -e \r -M insert bind -e \r -M insert
bind -e \r -M visual bind -e \r -M visual
end end
if test -n (bind \n --user 2>/dev/null | string match -e _omp_enter_key_handler) if bind \n --user 2>/dev/null | string match -q -e _omp_enter_key_handler
bind -e \n -M default bind -e \n -M default
bind -e \n -M insert bind -e \n -M insert
bind -e \n -M visual bind -e \n -M visual
end end
if test -n (bind \cc --user 2>/dev/null | string match -e _omp_ctrl_c_key_handler) if bind \cc --user 2>/dev/null | string match -q -e _omp_ctrl_c_key_handler
bind -e \cc -M default bind -e \cc -M default
bind -e \cc -M insert bind -e \cc -M insert
bind -e \cc -M visual bind -e \cc -M visual
end end
if test -n (bind \x20 --user 2>/dev/null | string match -e _omp_space_key_handler) if bind \x20 --user 2>/dev/null | string match -q -e _omp_space_key_handler
bind -e \x20 -M default bind -e \x20 -M default
bind -e \x20 -M insert bind -e \x20 -M insert
end end
@ -175,11 +175,11 @@ function _omp_enter_key_handler
end end
if commandline --is-valid || test -z (commandline --current-buffer | string trim -l | string collect) if commandline --is-valid || test -z (commandline --current-buffer | string trim -l | string collect)
set _omp_new_prompt true set _omp_new_prompt 1
set _omp_tooltip_command '' set _omp_tooltip_command ''
if test $_omp_transient_prompt = 1 if test $_omp_transient_prompt = 1
set _omp_transient true set _omp_transient 1
commandline --function repaint commandline --function repaint
end end
end end
@ -193,11 +193,11 @@ function _omp_ctrl_c_key_handler
end end
# Render a transient prompt on Ctrl-C with non-empty command line buffer. # Render a transient prompt on Ctrl-C with non-empty command line buffer.
set _omp_new_prompt true set _omp_new_prompt 1
set _omp_tooltip_command '' set _omp_tooltip_command ''
if test $_omp_transient_prompt = 1 if test $_omp_transient_prompt = 1
set _omp_transient true set _omp_transient 1
commandline --function repaint commandline --function repaint
end end
@ -219,3 +219,9 @@ bind \cc _omp_ctrl_c_key_handler -M visual
function enable_poshtransientprompt function enable_poshtransientprompt
return return
end end
# This can be called by user whenever re-rendering is required.
function omp_repaint_prompt
set _omp_new_prompt 1
commandline --function repaint
end

15
website/docs/faq.mdx
View file

@ -277,7 +277,18 @@ This is most likely caused by two Oh My Posh init lines in your `.zshrc`, remove
### Fish: Display current bind (Vim) mode ### Fish: Display current bind (Vim) mode
Use the `set_poshcontext` function to export the current mode. Note that scope shadowing must be disabled in order to By default, Oh My Posh will not re-render the prompt (i.e., generate a new prompt) until a new command is run, so you should
call the `omp_repaint_prompt` function to do prompt re-rendering whenever `$fish_bind_mode` changes:
```fish
function rerender_on_bind_mode_change --on-variable fish_bind_mode
if test "$fish_bind_mode" != paste
omp_repaint_prompt
end
end
```
Then export the current bind mode in the `set_poshcontext` function. Note that scope shadowing must be disabled in order to
access the `$fish_bind_mode` variable. access the `$fish_bind_mode` variable.
```fish ```fish
@ -286,7 +297,7 @@ function set_poshcontext --no-scope-shadowing
end end
``` ```
You can then use this in a template, for example this replicates the [example in the Fish documentation][fish-mode-prompt]: After that, you can use the value in a template. The following replicates the [example in the Fish documentation][fish-mode-prompt]:
```json ```json
{ {