mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-09-21 10:29:01 +00:00
268 lines
6.9 KiB
Markdown
268 lines
6.9 KiB
Markdown
# v0.45への移行
|
||
|
||
Starship v0.45.0は、v1.0.0の準備として互換性の無い変更を含むリリースになります。 私たちはより多くのカスタマイズを可能にするために、プロンプトでの設定方法にいくつかの大きな変更を加えました。
|
||
|
||
このガイドは、互換性のない変更を説明することを意図しています。
|
||
|
||
## `prompt_order`をルートレベルの`format`に置換
|
||
|
||
v0.45.0までは、`prompt_order` はStarshipによってレンダリングされる順序でモジュール名の配列を指定できるようになっていました。
|
||
|
||
Starship v0.45.0 では代わりに `format` を指定できるようになり、モジュール外でプロンプトをカスタマイズ可能になります。
|
||
|
||
**v0.45.0以前の設定例**
|
||
|
||
```toml
|
||
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での設定例**
|
||
|
||
```toml
|
||
format = """\
|
||
$username\
|
||
$hostname\
|
||
$directory\
|
||
$git_branch\
|
||
$git_commit\
|
||
$git_state\
|
||
$git_status\
|
||
$cmd_duration\
|
||
$custom\
|
||
$line_break\
|
||
$jobs\
|
||
$battery\
|
||
$time\
|
||
$character\
|
||
"""
|
||
```
|
||
|
||
## モジュールの `prefix`と `suffix` を `format`に置換
|
||
|
||
v0.45.0以前では、モジュールのレンダリング方法をのスタイルを設定するために、 `prefix` や`suffix` を指定可能なモジュールがありました。
|
||
|
||
Starship v0.45.0 は代わりに `format` の値を受け付け、モジュールのレンダリング方法をさらにカスタマイズすることができます。 prefix とsuffix を定義する代わりに、コンテキストベースの変数については、モジュールの出力を表現するフォーマット文字列の中から変数を置き換えることができるようになりました。
|
||
|
||
**v0.45.0以前の設定例**
|
||
|
||
```toml
|
||
[cmd_duration]
|
||
prefix = "took "
|
||
```
|
||
|
||
**v0.45.0での設定例**
|
||
|
||
```toml
|
||
[cmd_duration]
|
||
# $duration – コマンド実行時間 (例: "15s")
|
||
# $style – デフォルトのモジュールスタイル (例: "bold yellow")
|
||
format = "took [$duration]($style) "
|
||
```
|
||
|
||
### 影響を受けるモジュール
|
||
|
||
#### Character
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ----------------------- | ---------------- |
|
||
| `symbol` | `success_symbol` |
|
||
| `use_symbol_for_status` | `error_symbol` |
|
||
| `style_success` | `success_symbol` |
|
||
| `style_failure` | `error_symbol` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[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` を表示するようにプロンプトを設定しました。
|
||
|
||
v0.45.0 のリリースでは、ステータスコードがゼロでないときに `error_symbol` を常に使用するようになりました。 `use_symbol_for_status` と `error_symbol` プロパティを統合します。
|
||
|
||
以前の `use_symbol_for_status = true` 設定を使用するようにプロンプトを設定するには、次の設定ファイルを追加します。
|
||
|
||
```toml
|
||
[character]
|
||
error_symbol = "[✖](bold red)"
|
||
```
|
||
|
||
_注意:_ `character` 要素は自動的にスペースを後ろに追加するため、他の `format` 文字列とは異なり、上記の例では特にスペースを追加していません。
|
||
|
||
#### Command Duration
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ---------- | -------- |
|
||
| `prefix` | `format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[cmd_duration]
|
||
-- prefix = "took "
|
||
++ format = "took [$duration]($style) "
|
||
```
|
||
|
||
#### Directory
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ---------- | -------- |
|
||
| `prefix` | `format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[directory]
|
||
-- prefix = "in "
|
||
++ format = "[$path]($style)[$read_only]($read_only_style) "
|
||
```
|
||
|
||
#### Environment Variable
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ---------- | -------- |
|
||
| `prefix` | `format` |
|
||
| `suffix` | `format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[env_var]
|
||
-- prefix = ""
|
||
-- suffix = ""
|
||
++ format = "with [$env_value]($style) "
|
||
```
|
||
|
||
#### Git Commit
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ---------- | -------- |
|
||
| `prefix` | `format` |
|
||
| `suffix` | `format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[git_commit]
|
||
-- prefix = "("
|
||
-- suffix = ")"
|
||
++ format = '[\($hash\)]($style) '
|
||
```
|
||
|
||
#### Git Status
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ----------------- | -------- |
|
||
| `prefix` | `format` |
|
||
| `suffix` | `format` |
|
||
| `show_sync_count` | `format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[git_status]
|
||
-- prefix = "["
|
||
-- suffix = "]"
|
||
-- show_sync_count = false
|
||
++ format = '([\[$all_status$ahead_behind\]]($style) )'
|
||
```
|
||
|
||
以前は `show_sync_count` プロパティを使用して、 ブランチが先行またはリモートブランチの後ろにあるコミット数を表示するようにプロンプトを設定していました。
|
||
|
||
v0.45.0からは、`ahead`、`behind`と`diverged`に分けて設定するように変更されました。
|
||
|
||
以前の `show_sync_count = true` 設定を使用するようにプロンプトを構成するには、次の設定ファイルを設定します。
|
||
|
||
```toml
|
||
[git_status]
|
||
ahead = "⇡${count}"
|
||
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
|
||
behind = "⇣${count}"
|
||
```
|
||
|
||
#### Hostname
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ---------- | -------- |
|
||
| `prefix` | `format` |
|
||
| `suffix` | `format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[hostname]
|
||
-- prefix = ""
|
||
-- suffix = ""
|
||
++ format = "[$hostname]($style) in "
|
||
```
|
||
|
||
#### Singularity
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ---------- | -------- |
|
||
| `label` | `format` |
|
||
| `prefix` | `format` |
|
||
| `suffix` | `format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[singularity]
|
||
-- prefix = ""
|
||
-- suffix = ""
|
||
++ format = '[$symbol\[$env\]]($style) '
|
||
```
|
||
|
||
#### Time
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ---------- | ------------- |
|
||
| `format` | `time_format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[time]
|
||
-- format = "🕙[ %T ]"
|
||
++ time_format = "%T"
|
||
++ format = "at 🕙[$time]($style) "
|
||
```
|
||
|
||
#### Custom Commands
|
||
|
||
| 削除されたプロパティ | 置換後 |
|
||
| ---------- | -------- |
|
||
| `prefix` | `format` |
|
||
| `suffix` | `format` |
|
||
|
||
**デフォルト設定への変更**
|
||
|
||
```diff
|
||
[custom.example]
|
||
-- prefix = ""
|
||
-- suffix = ""
|
||
++ format = "[$symbol$output]($style) "
|
||
```
|