Migrasi ke v0.45.0

Starship v0.45.0 merupakan rilisan dengan perubahan yang signifikan, untuk persiapan v1.0.0 yang besar. Kami membuat beberapa perubahan besar tentang bagaimana konfigurasi dilakukan pada prompt, hingga bagaimana kami mengizinkan tingkat kustomisasi yang lebih luas.

Petunjuk berikut memandu kamu ke perubahan besar kami.

prompt_order kini digantikan dengan sebuah format root-level

Sebelum v0.45.0, prompt_order dapat menerima masukan berupa sebuah nama modul dengan urutan yang harusya di-render oleh Starship.

Starship v0.45.0 kini menerima nilai dari format, memungkinkan kustomisasi prompt di luar modul itu sendiri.

Contoh konfigurasi pra-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",
]

Contoh konfigurasi v0.45.0

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

Modul prefix dan suffix kini digantikan dengan format

Sebelum v0.45.0, beberapa modul bisa menerima prefix dan/atau suffix untuk menata gayanya sesuai modul yang di-render.

Starship v0.45.0 menerima nilai format sebagai gantinya, yang memungkinkan bagaimana modul di-render untuk kustomisasi yang lebih jauh. Daripada membuat prefix dan suffix untuk varibel yang berbasis konteks, kini variabel dapat disubtitusikan dari dalam sebuah format string, yang mana mewakili hasil keluaran dari modul.

Contoh konfigurasi pra-v0.45.0

[cmd_duration]
prefix = "took "

Contoh konfigurasi 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) "

Modul yang terpengaruh

Karakter

Properti Yang Digantikan	Penggantinya
symbol	success_symbol
use_symbol_for_status	error_symbol
style_success	success_symbol
style_failure	error_symbol

Perubahan pada konfigurasi bawaan

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

Sebelumnya, properti use_symbol_for_status digunakan untuk mengkonfigurasi prompt buat menampilkan error_symbol saat perintah terakhir berakhir dengan nilai code status yang bukan nol.

Dengan rilisnya v0.45.0, kini kita selalu memakai error_symbol setelah nilai code status yang bukan nol, untuk menyatukan properti use_symbol_for_status dan error_symbol.

Untuk mengkonfigurasi prompt agar menggunakan konfigurasi use_symbol_for_status = true, tambahkan baris berikut ke dalam file config:

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

Catatan: Element character secara otomatis menambahkan sebuah spasi setelahnya, jadi tidak seperti format string yang lain, kami secara spesifik tidak menambahkannya pada contoh di atas.

Durasi Perintah

Properti Yang Digantikan	Penggantinya
prefix	format

Perubahan pada konfigurasi bawaan

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

Direktori

Properti Yang Digantikan	Penggantinya
prefix	format

Perubahan pada konfigurasi bawaan

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

Variabel Environment

Properti Yang Digantikan	Penggantinya
prefix	format
suffix	format

Perubahan pada konfigurasi bawaan

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

Git Commit

Properti Yang Digantikan	Penggantinya
prefix	format
suffix	format

Perubahan pada konfigurasi bawaan

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

Git Status

Properti Yang Digantikan	Penggantinya
prefix	format
suffix	format
show_sync_count	format

Perubahan pada konfigurasi bawaan

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

Sebelumnya, properti show_sync_count digunakan untuk mengkonfigurasi prompt buat menampilkan jumlah commits dari branch yang terdepan atau terbelakang dari remote branch.

Dengan rilisnya v0.45.0, hal ini kini digantikan dengan tiga properti terpisah, ahead, behind, dan diverged.

Untuk mengkonfigurasi prompt agar menggunakan konfigurasi show_sync_count = true, tambahkan baris berikut ke dalam file config:

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

Hostname

Properti Yang Digantikan	Penggantinya
prefix	format
suffix	format

Perubahan pada konfigurasi bawaan

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

Singularity

Properti Yang Digantikan	Penggantinya
label	format
prefix	format
suffix	format

Perubahan pada konfigurasi bawaan

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

Waktu

Properti Yang Digantikan	Penggantinya
format	time_format

Perubahan pada konfigurasi bawaan

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

Custom Commands

Properti Yang Digantikan	Penggantinya
prefix	format
suffix	format

Perubahan pada konfigurasi bawaan

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