starship/docs/pt-BR/advanced-config

Configuração avançada

Ainda que Starship seja um shell versátil, às vezes você precisará fazer algumas outras coisas além de editar o arquivo <code>starship.toml. Esta página detalha algumas das configurações mais avançadas usadas em starship.

::: warning

As configurações nesta seção estão sujeitas a alterações em futuras versões do Starship.

:::

Comandos personalizados de pre-prompt e pre-execution no Bash

O Bash não possui uma estrutura formal para os hooks preexec/precmd como a maioria dos outros shells. Por esse motivo, é difícil fornecer hooks totalmente customizáveis no bash. No entanto, Starship te oferece uma capacidade limitada de inserir suas próprias funções na processo de prompt-rendering:

• Para rodar uma função personalizada antes do prompt iniciar, defina uma nova função e atribua seu nome para starship_precmd_user_func. Por exemplo, para desenhar um foguete antes do prompt iniciar você faria

function blastoff(){
    echo "🚀"
}
starship_precmd_user_func="blastoff"

• Para rodar uma função personalizada antes que um comando seja executado, você pode usar DEBUG como mecanismo de armadilha. No entanto, você deve prender o sinal de DEBUG antes de inicializar o Starship! O Starship consegue preservar o valor da armadilha DEBUG, mas se a armadilha for substituída depois do starship iniciar, algumas funções iram quebrar.

function blastoff(){
    echo "🚀"
}
trap blastoff DEBUG     # Trap Inicia o debug antes de iniciar o starship
eval $(starship init bash)

Altera o título da janela

Alguns shell prompts iram alterar o titulo da janela automaticamente para você (e.x: para espelhar o diretório atual). Fish faz isso por padrão. Starship não faz isso, mas é bastante simples adicionar esta funcionalidade ao bash ou zsh.

Primeiro, defina uma função de alteração de titulo de janela (é o mesmo para bash e zsh):

function set_win_title(){
    echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
}

Você pode usar variáveis para customizar o titulo ($USER, $HOSTNAME, e $PWD são escolhas populares).

No bash, defina esta função como a precedente da função starship:

starship_precmd_user_func="set_win_title"

No zsh, adicione no array precmd_functions:

precmd_functions+=(set_win_title)

Se você gostar do resultado, adicione esta linha ao seu arquivo de configuração de shell (~/.bashrc or ~/.zshrc) para torna-lo permanente.

Por exemplo, se você quiser exibir seu diretório atual no seu titulo de aba do terminal, adicione o seguinte snippet ao seu ~/.bashrc ou ~/.zshrc:

function set_win_title(){
    echo -ne "\033]0; $(basename "$PWD") \007"
}
starship_precmd_user_func="set_win_title"

Ativando o Prompt Direito

Alguns shells suportam um prompt no lado direito que renderiza na mesma linha do input. Starship consegue definir o conteúdo do prompt direito usando a opção right_format. Qualquer módulo pode ser usado no format é suportado o right_format. A variável $all só irá alterar os módulos que não usaram de forma explicita o format ou right_format.

Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the fill module.

right_format is currently supported for the following shells: elvish, fish, zsh.

Exemplo

# ~/.config/starship.toml

# Um prompt esquerdo minimo 
format = """$character"""

# Move o resto do prompt para direita
right_format = """$all"""

Gera um prompt parecido com o seguinte:

▶                                   starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s

Estilo dos textos

Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. bold and BoLd are considered the same string). Each word can be one of the following:

• bold
• italic
• underline
• dimmed
• inverted
• bg:<color>
• fg:<color>
• <color>
• none

where <color> is a color specifier (discussed below). fg:<color> and <color> currently do the same thing, though this may change in the future. inverted swaps the background and foreground colors. The order of words in the string does not matter.

The none token overrides all other tokens in a string if it is not part of a bg: specifier, so that e.g. fg:red none fg:blue will still create a string with no styling. bg:none sets the background to the default color so fg:red bg:none is equivalent to red or fg:red and bg:green fg:red bg:none is also equivalent to fg:red or red. It may become an error to use none in conjunction with other tokens in the future.

A color specifier can be one of the following:

• Um dos padrões de cores no terminal: black, red, green, blue, yellow, purple, cyan, white. Você pode de forma opcional prefixar com bright- para obter uma versão mais brilhante/clara (ex bright-white).
• Um # seguido por um número de seis dígitos hexadecimais. Isto especifica um Código RGB em formato hexadecimal.
• Um número entre 0-255. Este especifica um Código de Cor ANSI 8 bits.

If multiple colors are specified for foreground/background, the last one in the string will take priority.