mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-03 02:18:27 +00:00

History

Matan Kushner 5de3f18bce docs(i18n): new Crowdin updates (#3218 )		2021-12-20 16:05:59 -05:00
..
README.md	docs(i18n): new Crowdin updates (#3218 )	2021-12-20 16:05:59 -05:00

README.md

高度な設定

Starship は汎用性の高いシェルですが、時には特定の処理を行うために starship.toml を編集する以上のことをする必要があります。このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。

::: warning

ここに載せられた設定は、Starship の将来のリリースで変更される可能性があります。

:::

Bashのカスタムの事前プロンプトおよび事前実行コマンド

Bashには、他のほとんどのシェルとは違い、正式な preexec / precmd フレームワークを持っていません。そのため、 bashで完全にカスタマイズ可能なフックを提供することは困難です。ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。

関数をプロンプトが描画される直前に実行するためには、新しい関数を定義して starship_precmd_user_func に割り当ててください。例として、ロケットをプロンプトの前に表示させたければ、下記のようにしてください。

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

コマンドの直前に関数を実行するために、DEBUG トラップの仕組みを使うことができます。しかし、Starship を初期化する前に DEBUG シグナルをトラップしなければいけません！ Starship は DEBUGトラップの値を保護できますが、 starship の起動後にトラップが上書きされると、いくつかの機能は壊れてしまうでしょう。

function blastoff(){
    echo "🚀"
}
trap blastoff DEBUG     # starshipを起動する前にDEBUGをトラップする
eval $(starship init bash)

Custom pre-prompt and pre-execution Commands in PowerShell

PowerShell does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in powershell. ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。

Create a function named Invoke-Starship-PreCommand

function Invoke-Starship-PreCommand {
    $host.ui.Write("🚀")
}

ウィンドウのタイトルの変更

いくつかのシェルプロンプトはあなたのためにウィンドウのタイトルを自動的に変更します(例えば、カレントディレクトリを反映するために)。特に Fish はデフォルトで変更を行います。 Starship はこれをしませんが、この機能を bash や zsh に追加することは簡単にできます。

まず、ウィンドウのタイトルを変更する関数を定義してください（ bash も zsh も同様に）

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

タイトルをカスタマイズするために変数を利用することができます ($USER 、 $HOSTNAME、 $PWD が一般的です)。

bash では関数を starship の precmd 関数としてセットしてください。

starship_precmd_user_func="set_win_title"

zshでは関数を precmd_functions の配列に追加してください。

precmd_functions+=(set_win_title)

もし結果に満足したら、永続化のためそれぞれの行をシェルの設定ファイル (~/.bashrc もしくは ~/.zshrc) に追加してください。

たとえば、現在のディレクトリをターミナルタブのタイトルに表示したい場合は、 ~/.bashrcまたは~/.zshrcに以下のスニペットを追加します。

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

You can also set a similar output with PowerShell by creating a function named Invoke-Starship-PreCommand.

# edit $PROFILE
function Invoke-Starship-PreCommand {
  $host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a")
}

Invoke-Expression (&starship init powershell)

右プロンプトの有効化

シェルによっては、入力と同じ行にレンダリングされる右プロンプトをサポートしています。 Starship では right_format オプションを使って右プロンプトの内容を設定できます。 formatで使用できるモジュールはすべてright_formatでも使用できます。変数$allには、formatやright_formatで明示的に使用されていないモジュールのみが格納されます。

注意: 右プロンプトは入力の場所に続く単一の行です。複数行のプロンプトで入力行の上を右寄せにするには、fillモジュールを参照してください。

right_format は現在、次のシェルでサポートされています: elvish, fish, zsh

設定例

# ~/.config/starship.toml

# A minimal left prompt
format = """$character"""

# move the rest of the prompt to the right
right_format = """$all"""

次のようなプロンプトが生成されます:

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

スタイルの設定

スタイル文字列は空白で区切られた単語のリストです。大文字小文字を区別しません（例えば、 bold とBoLd は同じだとみなされます）。それぞれ以下のいずれか一つが該当します。

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

ここで、 <color> は色を指定します（以下で述べます）。現在 fg:<color> と <color> は同様の動作ですが、将来変更される可能性があります。 inverted は背景と前景の色を交換します。文字列中の単語の順序は関係ありません。

none トークンは、文字列中のbg: 指定子の一部でない場合、他のすべてのトークンをオーバーライドします。そのため、たとえば、fg:red none fg:blue と指定した場合、スタイルなしの文字列が作られます。 bg:none は背景色をデフォルトの色にセットするので、fg:red bg:none は red や fg:red と同じ意味になり、bg:green fg:red bg:none も fg:red や red と同じ意味になります。将来 none を他の単語と一緒に使用することはエラーになるかもしれません。

色は以下のいずれか1つを指定できます。

標準的なターミナルカラーの black、 red、 green、 blue、 yellow、 purple、 cyan、 white。必要に応じて、より明るい色を得るために bright- を前につけることができます。（例えば、 bright-white ）
# に続く16進数。 RGB の16進数カラーコードを表します。
0-255 までの間の数字。 8-bit ANSI カラーコードを表します。

複数の色が文字色/背景色に指定された際には、最後の指定が優先して選ばれます。

README.md Unescape Escape