Міграція на v0.45.0

Starship v0.45.0 — це реліз, що містить останні зміни, на шляху до версії v1.0.0. Ми внесли кілька суттєвих змін у те, як виконується налаштування командного рядка, щоб забезпечити більший ступінь налаштувань.

Цей посібник має на меті ознайомити вас із критичними змінами.

prompt_order було замінено на format кореневого рівня

Раніше до версії 0.45.0 prompt_order приймав масив імен модулів у порядку, в якому їх мав показувати Starship.

Натомість Starship v0.45.0 приймає значення format, що дозволяє налаштувати командний рядок поза межами самих модулів.

Приклад налаштувань pre-v0.45.0

prompt_order = [
  "username",
  "hostname",
  "directory",
  "git_branch",
  "git_commit",
  "git_state",
  "git_status",
  "cmd_duration",
  "custom",
  "line_break",
  "jobs",
  "battery",
  "time",
  "character",
]

Приклад налаштувань v0.45.0

format = """\
  $username\
  $hostname\
  $directory\
  $git_branch\
  $git_commit\
  $git_state\
  $git_status\
  $cmd_duration\
  $custom\
  $line_break\
  $jobs\
  $battery\
  $time\
  $character\
  """

Модулі prefix та suffix були замінені на format

До версії 0.45.0 деякі модулі приймали prefix та/або suffix, щоб стилізувати спосіб показу модулів.

Натомість Starship v0.45.0 приймає значення format, що дозволяє додатково налаштовувати спосіб показу модулів. Замість визначення префікса та суфікса для контекстних змінних тепер змінні можна замінити з рядка формату, який представляє вихідні дані модуля.

Приклад налаштувань pre-v0.45.0

[cmd_duration]
prefix = "took "

Приклад налаштувань v0.45.0

[cmd_duration]
# $duration – The command duration (e.g. "15s")
# $style    – The default style of the module (e.g. "bold yellow")
format = "took [$duration]($style) "

Вражені модулі

Character

Зміни до стандартної конфігурації

[character]
-- symbol = "❯"
-- error_symbol = "✖"
-- use_symbol_for_status = true
-- vicmd_symbol = "❮"
++ success_symbol = "[❯](bold green)"
++ error_symbol = "[❯](bold red)"
++ vicmd_symbol = "[❮](bold green)"

Раніше параметр use_symbol_for_status використовувався для налаштування запиту на показ error_symbol, коли остання команда призводила до ненульового коду стану.

З випуском версії 0.45.0 ми тепер завжди використовуємо error_symbol після ненульових кодів стану, об’єднуючи параметри use_symbol_for_status і error_symbol.

Щоб налаштувати запит на використання старішої конфігурації use_symbol_for_status = true, додайте наступне до свого файлу налаштувань:

[character]
error_symbol = "[✖](bold red)"

Примітка: Елемент character автоматично додає пробіл після, тому, на відміну від інших рядків format, ми спеціально не додаємо його в наведених вище прикладах.

Command Duration – час виконання

Зміни до стандартної конфігурації

[cmd_duration]
-- prefix = "took "
++ format = "took [$duration]($style) "

Directory

Зміни до стандартної конфігурації

[directory]
-- prefix = "in "
++ format = "[$path]($style)[$read_only]($read_only_style) "

Environment Variable

Зміни до стандартної конфігурації

[env_var]
-- prefix = ""
-- suffix = ""
++ format = "with [$env_value]($style) "

Git Commit

Зміни до стандартної конфігурації

[git_commit]
-- prefix = "("
-- suffix = ")"
++ format = '[\($hash\)]($style) '

Git Status

Зміни до стандартної конфігурації

[git_status]
-- prefix = "["
-- suffix = "]"
-- show_sync_count = false
++ format = '([\[$all_status$ahead_behind\]]($style) )'

Раніше параметр show_sync_count використовувався для налаштування запиту на показ кількості комітів, на які гілка була попереду або позаду віддаленої гілки.

З випуском версії 0.45.0 це було замінено трьома окремими параметрами: ahead, behind і diverged.

Щоб налаштувати командний рядок на використання старішої конфігурації show_sync_count = true, встановіть у файлі налаштувань таке:

[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"

Hostname

Зміни до стандартної конфігурації

[hostname]
-- prefix = ""
-- suffix = ""
++ format = "[$hostname]($style) in "

Singularity

Зміни до стандартної конфігурації

[singularity]
-- prefix = ""
-- suffix = ""
++ format = '[$symbol\[$env\]]($style) '

Time

Зміни до стандартної конфігурації

[time]
-- format = "🕙[ %T ]"
++ time_format = "%T"
++ format = "at 🕙[$time]($style) "

Власні команди

Зміни до стандартної конфігурації

[custom.example]
-- prefix = ""
-- suffix = ""
++ format = "[$symbol$output]($style) "