pkg_version:1.17.1
branch:master
commit_hash:
build_time:2024-01-02 18:32:30 +00:00
build_env:rustc 1.75.0 (82e1608df 2023-12-21),

Current Behavior

When using eval "$(starship init bash)" in my bashrc, when I start Visual Studio Code integrated terminal, it loads correctly, but if I try to source my bashrc manually during the session, the terminal crashes (and closes).

Expected Behavior

The vscode integrated terminal does not crash when running eval "$(starship init bash)" twice in the same terminal.

More context

• Tested on Windows 10 with vscode 1.87.0, with lot of extensions and WSL as the terminal backend
• Tested on Ubuntu 22.04 with vscode 1.86.2, fresh install, no extensions
• Both OS with same version of starship (1.17.1)

If eval "$(starship init bash)" is not run as part of bashrc (or any sourced file at terminal startup), running it multiple times in the terminal works perfectly. The problem appears when it is executed at terminal startup. May be linked to how vscode handles its shell integration.

My debug results

TL;DR: infinite loop caused by starship preserving PROMPT_COMMAND, and by vscode also preserving PROMPT_COMMAND.

$ # This is a fresh terminal in vscode, with shell integration enabled, and with starship init in bashrc.

$ type -t starship_precmd
function

$ echo $PROMPT_COMMAND 
__vsc_prompt_cmd_original

$ type __vsc_prompt_cmd_original
__vsc_prompt_cmd_original is a function
__vsc_prompt_cmd_original () 
{ 
    __vsc_status="$?";
    __vsc_restore_exit_code "${__vsc_status}";
    for cmd in "${__vsc_original_prompt_command[@]}";
    do
        eval "${cmd:-}";
    done;
    __vsc_precmd
}

$ echo "${__vsc_original_prompt_command[@]}"
starship_precmd

$ type __vsc_precmd
__vsc_precmd is a function
__vsc_precmd () 
{ 
    __vsc_command_complete "$__vsc_status";
    __vsc_current_command="";
    __vsc_update_prompt
}

_PRESERVED_PROMPT_COMMAND:
• me@host:~ fancyprompt
$ # this was a new terminal opened in vscode

• me@host:~ fancyprompt
$ . ~/.bashrc

_PRESERVED_PROMPT_COMMAND: __vsc_prompt_cmd_original
# (then terminal crashes)

Possible Solution

In starship.bash, add a verification specific to vscode:

• check if PROMPT_COMMAND is set to __vsc_prompt_cmd_original
• if not, then keep current behavior
• if it is:
  • do not redefine PROMPT_COMMAND
  • if ${__vsc_original_prompt_command[@]} does NOT contain starship_precmd, add it

Environment

• Starship version: 1.17.1
• bash version: GNU bash, version 5.2.26(1)-release (x86_64-unknown-linux-gnu)
  Copyright (C) 2022 Free Software Foundation, Inc.
  License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html

This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

• Operating system: Linux Unknown
• Terminal emulator: vscode 1.86.2
• Git Commit Hash:
• Branch/Tag: master
• Rust Version: rustc 1.75.0 (82e1608df 2023-12-21)
• Rust channel: release
• Build Time: 2024-01-02 18:32:30 +00:00

Relevant Shell Configuration

# minimalist ~/.bashrc for testing

# If not running interactively, don't do anything
case $- in
    *i*) ;;
      *) return;;
esac

shopt -s histappend
shopt -s checkwinsize
HISTCONTROL=ignoreboth
HISTSIZE=1000
HISTFILESIZE=2000

# Add ~/.local/bin in PATH if not already present
case :$PATH:
  in *:$HOME/.local/bin:*) ;; # do nothing, it's there
     *) export PATH="$HOME/.local/bin:$PATH" ;;
esac

# Fallback PS1
PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ '

command -v starship &>/dev/null && eval "$(starship init bash)"

alias ll='ls -alF'

Starship Configuration

Default (no file)