Files
starship/docs/pt-BR/migrating-to-0.45.0/README.md
T

268 lines
6.7 KiB
Markdown
Raw Normal View History

2022-04-18 09:48:28 -05:00
# Migrando para v0.45.0
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Starship v0.45.0 é o lançamento com grandes mudanças, em preparação para a grande versão v1.0.0. Nos fizemos algumas grandes mudanças em como é feita as configurações do prompt. para aceitar uma customização maior.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Este guia tem a intenção de conduzi-lo através das grandes mudanças.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
## `prompt_order` foi substituido por um formato padrão `format`
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Antes da v0.45.0, `prompt_order` aceitaria um array de módulos com a ordem em que seriam renderizados pelo Starship.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Starship v0.45.0 aceita um valor `format`, permitindo uma customização do prompt fora dos módulos.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Exemplo de configuração pre-v0.45.0**
2020-09-30 16:26:13 -04:00
```toml
prompt_order = [
"username",
"hostname",
"directory",
"git_branch",
"git_commit",
"git_state",
"git_status",
"cmd_duration",
"custom",
"line_break",
"jobs",
"battery",
"time",
"character",
]
```
2021-06-20 14:10:36 -04:00
**Exemplo de configuração v0.45.0**
2020-09-30 16:26:13 -04:00
```toml
format = """\
$username\
$hostname\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$cmd_duration\
$custom\
$line_break\
$jobs\
$battery\
$time\
$character\
"""
```
2021-06-20 14:10:36 -04:00
## Modulo `prefix` e `suffix` foram substituídos por `format`
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Antes da v0.45.0, alguns módulos aceitavam `prefix` e/ou `suffix` com o objetivo de estilizar a forma que o modulo seria renderizado.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Starship v0.45.0 aceita um valor `format`, que permite customizar como o modulo será renderizado. Em vez de definir um sufix e um prefix como variáveis de contexto, agora elas são substituídas por uma string que será a representação de como será a renderização do módulo.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Exemplo de configuração pre-v0.45.0**
2020-09-30 16:26:13 -04:00
```toml
[cmd_duration]
prefix = "took "
```
2021-06-20 14:10:36 -04:00
**Exemplo de configuração v0.45.0**
2020-09-30 16:26:13 -04:00
```toml
[cmd_duration]
# $duration The command duration (e.g. "15s")
# $style The default style of the module (e.g. "bold yellow")
2020-10-13 15:09:01 -04:00
format = "took [$duration]($style) "
2020-09-30 16:26:13 -04:00
```
2021-06-20 14:10:36 -04:00
### Módulos Afetados
2020-09-30 16:26:13 -04:00
#### Caractere
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
2020-09-30 16:26:13 -04:00
| ----------------------- | ---------------- |
| `symbol` | `success_symbol` |
| `use_symbol_for_status` | `error_symbol` |
| `style_success` | `success_symbol` |
| `style_failure` | `error_symbol` |
2022-03-24 15:47:11 -05:00
**Alterações na configuração padrão**
2020-09-30 16:26:13 -04:00
```diff
[character]
-- symbol = ""
-- error_symbol = "✖"
-- use_symbol_for_status = true
-- vicmd_symbol = ""
2020-10-13 15:09:01 -04:00
++ success_symbol = "[](bold green)"
++ error_symbol = "[](bold red)"
2020-09-30 16:26:13 -04:00
++ vicmd_symbol = "[](bold green)"
```
2021-06-20 14:10:36 -04:00
Anteriormente, a propriedade `use_symbol_for_status` era usada para configurar o prompt para exibir o `error_symbol` quando o ultimo comando resultou em um status diferente de zero.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Com a versão v0.45.0, nós agora sempre usamos `error_symbol` após status diferentes de zero, unificando as propriedades `use_symbol_for_status` e `error_symbol`.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Para configurar o prompt para usar a configuração antiga `use_symbol_for_status = true`, adicione o seguinte em seu arquivo de configuração:
2020-09-30 16:26:13 -04:00
```toml
[character]
2020-10-13 15:09:01 -04:00
error_symbol = "[✖](bold red)"
2020-09-30 16:26:13 -04:00
```
2022-03-24 15:47:11 -05:00
_Nota:_ O elemento `charactere` adiciona automaticamente um espaço depois do mesmo, portanto ao contrario strings `format`, nós não adicionamos o espaço nos exemplos acima.
2020-10-13 15:09:01 -04:00
2020-09-30 16:26:13 -04:00
#### Tempo de execução do comando
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------ |
| `prefix` | `format` |
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[cmd_duration]
-- prefix = "took "
2020-10-13 15:09:01 -04:00
++ format = "took [$duration]($style) "
2020-09-30 16:26:13 -04:00
```
2020-09-30 21:23:36 -04:00
#### Diretório
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------ |
| `prefix` | `format` |
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[directory]
-- prefix = "in "
2020-10-13 15:09:01 -04:00
++ format = "[$path]($style)[$read_only]($read_only_style) "
2020-09-30 16:26:13 -04:00
```
2021-06-20 14:10:36 -04:00
#### Variáveis de Ambiente
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------ |
| `prefix` | `format` |
| `suffix` | `format` |
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[env_var]
-- prefix = ""
-- suffix = ""
++ format = "with [$env_value]($style) "
```
2020-09-30 21:23:36 -04:00
#### Git commit
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------ |
| `prefix` | `format` |
| `suffix` | `format` |
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[git_commit]
-- prefix = "("
-- suffix = ")"
2020-10-13 15:09:01 -04:00
++ format = '[\($hash\)]($style) '
2020-09-30 16:26:13 -04:00
```
#### Git Status
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------ |
| `prefix` | `format` |
| `suffix` | `format` |
| `show_sync_count` | `format` |
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[git_status]
-- prefix = "["
-- suffix = "]"
-- show_sync_count = false
2020-10-13 15:09:01 -04:00
++ format = '([\[$all_status$ahead_behind\]]($style) )'
2020-09-30 16:26:13 -04:00
```
2021-06-20 14:10:36 -04:00
Anteriormente, a propriedade `show_sync_count` era usada para configurar o prompt para exibir o numero de commits que o branch estava a frente ou atrás do branch remoto.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Com a versão v0.45.0, isto foi substituído em propriedades separadas, `ahead`, `behind`, e `diverged`.
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
Para configurar o prompt para utilizar a configuração antiga, altere a seguinte propriedade no seu arquivo de configuração: `show_sync_count = true`:
2020-09-30 16:26:13 -04:00
```toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
#### Hostname
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------ |
| `prefix` | `format` |
| `suffix` | `format` |
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[hostname]
-- prefix = ""
-- suffix = ""
++ format = "[$hostname]($style) in "
```
2021-06-20 14:10:36 -04:00
#### Singularidade
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------ |
| `label` | `format` |
| `prefix` | `format` |
| `suffix` | `format` |
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[singularity]
-- prefix = ""
-- suffix = ""
2020-10-13 15:09:01 -04:00
++ format = '[$symbol\[$env\]]($style) '
2020-09-30 16:26:13 -04:00
```
2021-06-20 14:10:36 -04:00
#### Horário
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------- |
| `format` | `time_format` |
2020-09-30 16:26:13 -04:00
2021-06-20 14:10:36 -04:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[time]
-- format = "🕙[ %T ]"
++ time_format = "%T"
2020-10-13 15:09:01 -04:00
++ format = "at 🕙[$time]($style) "
2020-09-30 16:26:13 -04:00
```
2021-06-20 14:10:36 -04:00
#### Comandos Personalizados
2020-09-30 16:26:13 -04:00
2022-03-24 15:47:11 -05:00
| Propriedades Removidas | Substituição |
| ---------------------- | ------------ |
| `prefix` | `format` |
| `suffix` | `format` |
2020-09-30 16:26:13 -04:00
2022-03-24 15:47:11 -05:00
**Alterações na Configuração Padrão**
2020-09-30 16:26:13 -04:00
```diff
[custom.example]
-- prefix = ""
-- suffix = ""
++ format = "[$symbol$output]($style) "
```