diff options
author | Matan Kushner <hello@matchai.me> | 2019-09-28 20:31:56 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-28 20:31:56 +0900 |
commit | 85956c7f948b0d01b40a081a21b5808eb4564f31 (patch) | |
tree | e495cad55006c2a7cf79832f80f7edb33c856cfb /docs/ja | |
parent | c49e54b16bad5deb4f0b0ffc026b06e0c4a1996c (diff) |
docs(i18n): Finish translating documentation in Japanese (#433)
This last wave of translations has been completed on Crowdin.
Diffstat (limited to 'docs/ja')
-rw-r--r-- | docs/ja/README.md | 100 | ||||
-rw-r--r-- | docs/ja/advanced-config/README.md | 48 | ||||
-rw-r--r-- | docs/ja/config/README.md | 468 | ||||
l--------- | docs/ja/guide/README.md | 1 |
4 files changed, 365 insertions, 252 deletions
diff --git a/docs/ja/README.md b/docs/ja/README.md index d86f289c5..80ed0dee2 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -1,15 +1,15 @@ --- -home: 'true' -heroImage: "/logo.svg" +home: true +heroImage: /logo.svg actionText: Get Started → -actionLink: "/guide/" +actionLink: /ja/guide/ footer: ISC Licensed | Copyright © 2019-present Starship Contributors --- <div class="features"> <div class="feature"> <h2>互換性優先</h2> - <p>一般的なほとんどのOSの一般的なほとんどのシェル上で動作します。あらゆるところで使用してください!</p> + <p>一般的なほとんどのOSの一般的なほとんどのシェル上で動作します。 あらゆるところで使用してください!</p> </div> <div class="feature"> <h2>Rust 製</h2> @@ -25,75 +25,83 @@ footer: ISC Licensed | Copyright © 2019-present Starship Contributors <video class="demo-video" autoplay muted loop> <source src="/demo.webm" type="video/webm"> <source src="/demo.mp4" type="video/mp4"> - </source></source></video> + </video> </div> ### クイックインストール 1. **Starship** のバイナリをインストール - もし以下のプラットフォームを使用していない場合は **[コンパイル済みのバイナリファイルをダウンロード](https://github.com/starship/starship/releases)** してください。 + もし以下のプラットフォームを使用していない場合は **[コンパイル済みのバイナリファイルをダウンロード](https://github.com/starship/starship/releases)** してください。 - #### Homebrew - ```sh - $ brew install starship - ``` + #### Homebrew - #### Rust (v1.33 もしくはそれ以上) + ```sh + $ brew install starship + ``` - ```sh - $ cargo install starship - ``` - #### Arch Linux (AUR) + #### Rust (v1.33 もしくはそれ以上) - Starship は AUR 上の `starship` というパッケージ名で利用可能です。`yay` またはお好きな AUR ヘルパーでインストールしてください。 + ```sh + $ cargo install starship + ``` - ```sh - $ yay -S starship - ``` - #### Nix (unstable) + #### Arch Linux (AUR) - ```sh - $ nix-env --install starship - ``` + Starship は AUR 上の `starship` というパッケージ名で利用可能です。 `yay` またはお好きな AUR ヘルパーでインストールしてください。 - #### Termux + ```sh + $ yay -S starship + ``` - ```sh - $ pkg install starship - ``` -2. 初期化のためのスクリプトをシェルの設定ファイルに追加 + #### Nix (unstable) - #### Bash + ```sh + $ nix-env --install starship + ``` - `~/.bashrc` の最後に以下を追記してください - ```sh - # ~/.bashrc + #### Termux - eval "$(starship init bash)" - ``` + ```sh + $ pkg install starship + ``` - #### Fish +1. 初期化のためのスクリプトをシェルの設定ファイルに追加 - `~/.config/fish/config.fish` の最後に以下を追記してください - ```sh - # ~/.config/fish/config.fish + #### Bash - eval (starship init fish) - ``` + `~/.bashrc` の最後に以下を追記してください - #### Zsh + ```sh + # ~/.bashrc - `~/.zshrc` の最後に以下を追記してください + eval "$(starship init bash)" + ``` - ```sh - # ~/.zshrc - eval "$(starship init zsh)" - ``` + #### Fish + + `~/.config/fish/config.fish` の最後に以下を追記してください + + ```sh + # ~/.config/fish/config.fish + + eval (starship init fish) + ``` + + + #### Zsh + + `~/.zshrc` の最後に以下を追記してください + + ```sh + # ~/.zshrc + + eval "$(starship init zsh)" + ``` diff --git a/docs/ja/advanced-config/README.md b/docs/ja/advanced-config/README.md index e5e47806d..ba287c65d 100644 --- a/docs/ja/advanced-config/README.md +++ b/docs/ja/advanced-config/README.md @@ -1,16 +1,18 @@ # 高度な設定 -Starship は汎用性の高いシェルですが、時には特定の処理を行うために `starship.toml` を編集する以上のことをする必要があります。このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。 +Starship は汎用性の高いシェルですが、時には特定の処理を行うために `starship.toml` を編集する以上のことをする必要があります。 このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。 ::: warning + ここに載せられた設定は、Starship の将来のリリースで変更される可能性があります。 - ::: + +::: ## Bashのカスタムの事前プロンプトおよび事前実行コマンド -Bashには、他のほとんどのシェルとは違い、正式な preexec / precmd フレームワークを持っていません。そのため、 `bash`で完全にカスタマイズ可能なフックを提供することは困難です。ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。 +Bashには、他のほとんどのシェルとは違い、正式な preexec / precmd フレームワークを持っていません。 そのため、 `bash`で完全にカスタマイズ可能なフックを提供することは困難です。 ただし、Starship はプロンプトを描画する一連の流れに、限定的に独自の関数を挿入することができます。 -- 関数をプロンプトが描画される直前に実行するためには、新しい関数を定義して `starship_precmd_user_func` に割り当ててください。例として、ロケットをプロンプトの前に表示させたければ、 +- 関数をプロンプトが描画される直前に実行するためには、新しい関数を定義して `starship_precmd_user_func` に割り当ててください。 例として、ロケットをプロンプトの前に表示させたければ、下記のようにしてください。 ```bash function blastoff(){ @@ -19,20 +21,19 @@ function blastoff(){ starship_precmd_user_func="blastoff" ``` -- コマンドの直前に関数を実行するために、[`DEBUG` トラップの仕組み](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/)を使うことができます。しかし、Starship を初期化する前に DEBUG シグナルをトラップ**しなければいけません**!Starship は DEBUGトラップの値を保護できますが、 starship の起動後にトラップが上書きされると、いくつかの機能は壊れてしまうでしょう。 +- コマンドの直前に関数を実行するために、[`DEBUG` トラップの仕組み](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/)を使うことができます。 しかし、Starship を初期化する前に DEBUG シグナルをトラップ*しなければいけません*! Starship は DEBUGトラップの値を保護できますが、 starship の起動後にトラップが上書きされると、いくつかの機能は壊れてしまうでしょう。 ```bash function blastoff(){ echo "🚀" } -trap blastoff DEBUG # Trap DEBUG *before* running starship +trap blastoff DEBUG # starshipを起動する前にDEBUGをトラップする eval $(starship init bash) ``` ## ウィンドウのタイトルの変更 -いくつかのシェルプロンプトはあなたのためにウィンドウのタイトルを自動的に変更します(例えば、カレントディレクトリを反映するために)。特に Fish はデフォルトで変更を行います。 -Starship はこれをしませんが、この機能を `bash` や `zsh` に追加することは簡単にできます。 +いくつかのシェルプロンプトはあなたのためにウィンドウのタイトルを自動的に変更します(例えば、カレントディレクトリを反映するために)。 特に Fish はデフォルトで変更を行います。 Starship はこれをしませんが、この機能を `bash` や `zsh` に追加することは簡単にできます。 まず、ウィンドウのタイトルを変更する関数を定義してください( bash も zsh も同様に) @@ -56,29 +57,28 @@ starship_precmd_user_func="set_win_title" precmd_functions+=(set_win_title) ``` -もし結果に満足したら、永続化のためそれぞれの行を -(`~/.bashrc` もしくは `~/.zsrhc`) に追加してください。 +もし結果に満足したら、永続化のためそれぞれの行を (`~/.bashrc` もしくは `~/.zsrhc`) に追加してください。 -## 文字の装飾 +## スタイルの設定 -スタイル文字列は空白で区切られた単語のリストです。大文字小文字を区別しません(例えば、 `bold` と`BoLd` は同じだとみなされます)。それぞれ以下のいずれか一つが該当します。 +スタイル文字列は空白で区切られた単語のリストです。 大文字小文字を区別しません(例えば、 `bold` と`BoLd` は同じだとみなされます)。 それぞれ以下のいずれか一つが該当します。 -- `bold` -- `underline` -- `dimmed` -- `bg:<color>` -- `fg:<color>` -- `<color>` -- `none` + - `bold` + - `underline` + - `dimmed` + - `bg:<color>` + - `fg:<color>` + - `<color>` + - `none` -ここで、 `<color>` は色を指定します(以下で述べます)。 `fg:<color>` と `<color>` は現在同様の動作ですが、将来変更される可能性があります。文字列中の単語の順序は関係ありません。 +ここで、 `<color>` は色を指定します(以下で述べます)。 `fg:<color>` と `<color>` は現在同様の動作ですが、将来変更される可能性があります。 文字列中の単語の順序は関係ありません。 -例えば `fg:red none fg:blue` は依然としてスタイルのない文字列となるように、 `none` は他の文字列中の他の単語すべてを上書きします。将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。 +例えば `fg:red none fg:blue` は依然としてスタイルのない文字列となるように、 `none` は他の文字列中の他の単語すべてを上書きします。 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。 色は以下のいずれか1つを指定できます。 -- 標準的なターミナルカラーの `black`、 `red`、 `green`、 `blue`、`yellow`、 `purple`、 `cyan`、 `white`。必要に応じて、より明るい色を得るために `bright-` を前につけることができます。(例えば、 `bright-white` ) -- `#` に続く16進数。[RGB の16進数カラーコード](https://www.w3schools.com/colors/colors_hexadecimal.asp)を表します。 -- 0-255 までの間の数字。[8-bit ANSI カラーコード](https://i.stack.imgur.com/KTSQa.png) を表します。 + - 標準的なターミナルカラーの `black`、 `red`、 `green`、 `blue`、 `yellow`、 `purple`、 `cyan`、 `white`。 必要に応じて、より明るい色を得るために `bright-` を前につけることができます。(例えば、 `bright-white` ) + - `#` に続く16進数。 [RGB の16進数カラーコード](https://www.w3schools.com/colors/colors_hexadecimal.asp)を表します。 + - 0-255 までの間の数字。 [8-bit ANSI カラーコード](https://i.stack.imgur.com/KTSQa.png) を表します。 複数の色が文字色/背景色に指定された際には、最後の指定が優先して選ばれます。 diff --git a/docs/ja/config/README.md b/docs/ja/config/README.md index 5acead831..f07bde8ff 100644 --- a/docs/ja/config/README.md +++ b/docs/ja/config/README.md @@ -1,37 +1,39 @@ # 設定 ::: tip -🔥Starshipの開発は現在も進んでいます。多くの新しいオプションが今後のリリースで利用可能になります。 + +🔥Starshipの開発は現在も進んでいます。 多くの新しいオプションが今後のリリースで利用可能になります。 + ::: -starshipの設定を開始するには、`~/.config/starship.toml` ファイルを作成します。 +Starshipの設定を開始するには、`~/.config/starship.toml` ファイルを作成します。 ```shell $ touch ~/.config/starship.toml ``` -starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。 +Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。 ```toml -# プロンプト表示時に改行しない +# Don't print a new line at the start of the prompt add_newline = false -# "❯" から "➜" に表示を変更 -[character] # The name of the module we are confguring is "character" +# Replace the "❯" symbol in the prompt with "➜" +[character] # The name of the module we are configuring is "character" symbol = "➜" # The "symbol" segment is being set to "➜" -# packageモジュールを無効にする +# Disable the package module, hiding it from the prompt completely [package] disabled = true ``` ### 用語 -**モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。たとえば、現在のディレクトリがNodeJSプロジェクトである場合、「nodejs」モジュールは、現在コンピューターにインストールされているNodeJSのバージョンを表示します。 +**モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。 たとえば、現在のディレクトリがNodeJSプロジェクトである場合、「nodejs」モジュールは、現在コンピューターにインストールされているNodeJSのバージョンを表示します。 -**セグメント**: モジュールを構成する小さなサブコンポーネントです。たとえば、「nodejs」モジュールの「symbol」セグメントには、バージョン番号の前に表示される文字が含まれています(デフォルト: ⬢)。 +**セグメント**: モジュールを構成する小さなサブコンポーネントです。 たとえば、「nodejs」モジュールの「symbol」セグメントには、バージョン番号の前に表示される文字が含まれています(デフォルト: ⬢)。 -以下はNode モジュールの表現です。次の例では、「シンボル」と「バージョン」はその中のセグメントです。すべてのモジュールには、デフォルトの端末色であるprefixとsuffixもあります。 +以下はNode モジュールの表現です。 次の例では、「シンボル」と「バージョン」はその中のセグメントです。 すべてのモジュールには、デフォルトの端末色であるprefixとsuffixもあります。 ``` [prefix] [symbol] [version] [suffix] @@ -40,16 +42,16 @@ disabled = true ### スタイルの設定 -starshipのほとんどのモジュールでは、表示スタイルを設定できます。これは、設定を指定する文字列であるエントリ(`style`)で行われます。スタイル文字列の例とその機能を次に示します。完全な構文の詳細については、詳細は [高度な設定](/advanced-config/)を参照してください 。 +Starshipのほとんどのモジュールでは、表示スタイルを設定できます。 これは、設定を指定する文字列であるエントリ(`style`)で行われます。 スタイル文字列の例とその機能を次に示します。 完全な構文の詳細については、詳細は [高度な設定](/advanced-config/)を参照してください 。 -- `"fg:green bg:blue"`は、青色の背景に緑色のテキストを設定します -- `"bg:blue fg:bright-green"`は、青色の背景に明るい緑色のテキストを設定します -- `"bold fg:27"`は、 [ANSIカラー](https://i.stack.imgur.com/KTSQa.png) 27の太字テキストを設定します -- `"underline bg:#bf5700"`は、焦げたオレンジ色の背景に下線付きのテキストを設定します +- `"fg:green bg:blue"` は、青色の背景に緑色のテキストを設定します +- `"bg:blue fg:bright-green"` は、青色の背景に明るい緑色のテキストを設定します +- `"bold fg:27"` は、 [ANSIカラー](https://i.stack.imgur.com/KTSQa.png) 27の太字テキストを設定します +- `"underline bg:#bf5700"` は、焦げたオレンジ色の背景に下線付きのテキストを設定します - `"bold italic fg:purple"`は、紫色の太字斜体のテキストを設定します -- `""`はすべてのスタイルを明示的に無効にします +- `""` はすべてのスタイルを明示的に無効にします -スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。 +スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。 たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。スタイリングがどのように見えるかは、端末エミュレータによって制御されることに注意してください。たとえば、一部の端末エミュレータはテキストを太字にする代わりに色を明るくします。また、一部のカラーテーマは通常の色と明るい色と同じ値を使用します。 また、斜体のテキストを取得するには、端末で斜体をサポートする必要があります。 ## プロンプト @@ -57,10 +59,10 @@ starshipのほとんどのモジュールでは、表示スタイルを設定で ### オプション -変数 | デフォルト | 説明 ---- | --- | --- -`add_newline` | `true` | プロンプトの開始前に新しい行を追加します。 -`prompt_order` | [link](#デフォルトのプロンプト表示順) | プロンプトモジュールを出力する順序を設定します。 +| 変数 | デフォルト | 説明 | +| -------------- | ----------------------- | ------------------------ | +| `add_newline` | `true` | プロンプトの開始前に新しい行を追加します。 | +| `prompt_order` | [link](#デフォルトのプロンプト表示順) | プロンプトモジュールを出力する順序を設定します。 | ### 設定例 @@ -75,7 +77,7 @@ prompt_order=["rust","line_break","package","line_break","character"] ### デフォルトのプロンプト表示順 -デフォルトの`prompt_order`は、空の場合、または`prompt_order`が指定されていない場合に、プロンプトにモジュールが表示される順序を定義するために使用されます。デフォルトは次のとおりです。 +デフォルトの`prompt_order`は、空の場合、または`prompt_order`が指定されていない場合に、プロンプトにモジュールが表示される順序を定義するために使用されます。 デフォルトは次のとおりです。 ```toml prompt_order = [ @@ -91,29 +93,66 @@ prompt_order = [ "rust", "python", "golang", + "java", "nix_shell", + "aws", + "env_var", "cmd_duration", "line_break", "jobs", - "time", "battery", + "time", "character", ] ``` +## AWS + +`aws` モジュールは現在のAWSプロファイルが表示されます。 これは`AWS_PROFILE`環境変数に基づいています。 + +### オプション + +| 変数 | デフォルト | 説明 | +| ---------- | --------------- | ----------------------------- | +| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | `aws`モジュールを無効にします。 | + +### 設定例 + +```toml +# ~/.config/starship.toml + +[aws] +style = "bold blue" +symbol = "🅰 " +``` + ## バッテリー -`battery`モジュールは、デバイスのバッテリー残量と現在の充電状態を示します。モジュールは、デバイスのバッテリー残量が10%未満の場合にのみ表示されます。 +`battery`モジュールは、デバイスのバッテリー残量と現在の充電状態を示します。 モジュールは、デバイスのバッテリー残量が10%未満の場合にのみ表示されます。 ### オプション -変数 | デフォルト | 説明 ---- | --- | --- -`full_symbol` | `"•"` | バッテリーが満タンのときに表示される記号です。 -`charging_symbol` | `"⇡"` | バッテリーの充電中に表示される記号です。 -`discharging_symbol` | `"⇣"` | バッテリーが放電しているときに表示される記号です。 -`display` | [link](#バッテリーの表示) | モジュールの閾値とスタイルを表示します。 -`disabled` | `false` | `battery`モジュールを無効にします。 +| 変数 | デフォルト | 説明 | +| -------------------- | ------------------------ | ------------------------- | +| `full_symbol` | `"•"` | バッテリーが満タンのときに表示される記号です。 | +| `charging_symbol` | `"⇡"` | バッテリーの充電中に表示される記号です。 | +| `discharging_symbol` | `"⇣"` | バッテリーが放電しているときに表示される記号です。 | +| `display` | [link](#battery-display) | モジュールの閾値とスタイルを表示します。 | +| `disabled` | `false` | `battery`モジュールを無効にします。 | + +<details> +<summary>いくつかのまれなバッテリー状態のオプションもあります。</summary> + +| 変数 | 説明 | +| ---------------- | ------------------------ | +| `unknown_symbol` | バッテリー状態が不明なときに表示される記号です。 | +| `empty_symbol` | バッテリーが空のときに表示される記号です。 | + +オプションを指定しない限り、バッテリーの状態が`unknown`もしくは`empty`になった場合にインジケーターは非表示になります。 + +</details> ### 設定例 @@ -128,8 +167,8 @@ discharging_symbol = "💀" ### バッテリーの表示 -`display` 設定オプションは、バッテリーインジケーターを表示するタイミング(threshold)と見た目(style)を定義するために使用されます。 -`display` が設定されていない場合のデフォルトは次のとおりです: +`display</ 0> オプションを使用して、バッテリーインジケーターを表示するタイミング(閾値)と外観(スタイル)を定義します。 +<code>display` が提供されない場合、 デフォルトは次のとおりです。 ```toml [[battery.display]] @@ -141,10 +180,10 @@ style = "bold red" `display`オプションは、次の表の通りです。 -変数 | 説明 ---- | --- -`threshold` | バッテリーが表示される上限です。 -`style` | displayオプションが使用されている場合のスタイルです。 +| 変数 | 説明 | +| ----------- | ------------------------------ | +| `threshold` | バッテリーが表示される上限です。 | +| `style` | displayオプションが使用されている場合のスタイルです。 | #### 設定例 @@ -165,19 +204,19 @@ style = "bold yellow" `character`モジュールは、端末でテキストが入力される場所の横に文字(通常は矢印)を表示します。 -文字は、最後のコマンドが成功したかどうかを示します。これは、色の変更(赤/緑)またはその形状の変更(❯/✖)の2つの方法で行うことができます。後者は`use_symbol_for_status`に`true`設定されている場合にのみ行われます。 +文字は、最後のコマンドが成功したかどうかを示します。 これは、色の変更(赤/緑)またはその形状の変更(❯/✖) の2つの方法で行うことができます。 後者は`use_symbol_for_status`に`true`設定されている場合にのみ行われます。 ### オプション -変数 | デフォルト | 説明 ---- | --- | --- -`symbol` | `"❯"` | プロンプトでテキストを入力する前に使用される記号です。 -`error_symbol` | `"✖"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される記号です。 -`use_symbol_for_status` | `false` | シンボルを変更してエラーステータスを示します。 -`vicmd_symbol` | `"❮"` | シェルがvimの通常モードである場合、プロンプトのテキスト入力の前に使用される記号です。 -`style_success` | `"bold green"` | 最後のコマンドが成功した場合に使用されるスタイルです。 -`style_failure` | `"bold red"` | 最後のコマンドが失敗した場合に使用されるスタイルです。 -`disabled` | `false` | `character`モジュールを無効にします。 +| 変数 | デフォルト | 説明 | +| ----------------------- | -------------- | -------------------------------------------- | +| `symbol` | `"❯"` | プロンプトでテキストを入力する前に使用される記号です。 | +| `error_symbol` | `"✖"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される記号です。 | +| `use_symbol_for_status` | `false` | シンボルを変更してエラーステータスを示します。 | +| `vicmd_symbol` | `"❮"` | シェルがvimの通常モードである場合、プロンプトのテキスト入力の前に使用される記号です。 | +| `style_success` | `"bold green"` | 最後のコマンドが成功した場合に使用されるスタイルです。 | +| `style_failure` | `"bold red"` | 最後のコマンドが失敗した場合に使用されるスタイルです。 | +| `disabled` | `false` | `character`モジュールを無効にします。 | ### 設定例 @@ -192,21 +231,23 @@ use_symbol_for_status = true ## コマンド実行時間 -`cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。 +`cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。 ::: warning BashでDEBUGトラップをhookしない + `bash`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`DEBUG`トラップをフックしないでください。そうしないと、このモジュールが**おそらくですが**壊れます。 + ::: -preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions` 、および`precmd_functions`定義するだけで、通常どおり続行します。 +preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。 ### オプション -変数 | デフォルト | 説明 ---- | --- | --- -`min_time` | `2` | 時間を表示する最短期間です。 -`style` | `"bold yellow"` | モジュールのスタイルです。 -`disabled` | `false` | `cmd_duration`モジュールを無効にします。 +| 変数 | デフォルト | 説明 | +| ---------- | --------------- | --------------------------- | +| `min_time` | `2` | 時間を表示する最短期間です。 | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | `cmd_duration`モジュールを無効にします。 | ### 設定例 @@ -219,21 +260,30 @@ min_time = 4 ## ディレクトリ -`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。ディレクトリは、現在のgitリポジトリであるとルートとなります。 +`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在のgitリポジトリであるとルートとなります。 fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。 -たとえば、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合、`~/D/N/nixpkgs/pkgsが表示されますが、以前はnixpkgs/pkgs`でした。 +例として、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/nixpkgs/pkgs`が表示されます。 ### オプション -変数 | デフォルト | 説明 ---- | --- | --- -`truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 -`truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 -`fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 -`style` | `"bold cyan"` | モジュールのスタイルです。 -`disabled` | `false` | `directory`モジュールを無効にします。 +| 変数 | デフォルト | 説明 | +| ------------------- | ------------- | ----------------------------- | +| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 | +| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 | +| `style` | `"bold cyan"` | モジュールのスタイルです。 | +| `disabled` | `false` | `directory`モジュールを無効にします。 | + +<details> +<summary>このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。</summary> + +| 変数 | デフォルト | 説明 | +| --------------------------- | ------ | -------------------------------------------- | +| `fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 | +| `use_logical_path` | `true` | OSからのパスの代わりに、シェル(`PWD`) によって提供される論理パスを表示します。 | + +</details> ### 設定例 @@ -244,19 +294,48 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた truncation_length = 8 ``` +## 環境変数 + +`env_var`モジュールは、選択された環境変数の現在の値を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 + +- `variable`オプションが、既存の環境変数と一致する +- `variable`オプションが定義されておらず、`default`オプションが定義されている + +### オプション + +| 変数 | デフォルト | 説明 | +| ---------- | ---------------- | ------------------------------------- | +| `symbol` | | 環境変数を表示する前に使用される記号です。 | +| `variable` | | 表示される環境変数です。 | +| `default` | | 上のvariableが定義されていない場合に表示されるデフォルトの値です。 | +| `prefix` | `""` | 変数の直前に表示するprefixです。 | +| `suffix` | `""` | 変数の直後に表示するsuffixです。 | +| `style` | `"dimmed black"` | モジュールのスタイルです。 | +| `disabled` | `false` | `env_var`モジュールを無効にします。 | + +### 設定例 + +```toml +# ~/.config/starship.toml + +[env_var] +variable = "SHELL" +default = "unknown shell" +``` + ## Git ブランチ `git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。 ### オプション -変数 | デフォルト | 説明 ---- | --- | --- -`symbol` | `" "` | 現在のディレクトリのリポジトリのブランチ名の前に使用されるシンボルです。 -`truncation_length` | `2^63 - 1` | gitブランチをX書記素に切り捨てます -`truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。記号なしに「」も使用できます。 -`style` | `"bold purple"` | モジュールのスタイルです。 -`disabled` | `false` | `git_branch`モジュールを無効にします。 +| 変数 | デフォルト | 説明 | +| ------------------- | --------------- | ------------------------------------------- | +| `symbol` | `" "` | 現在のディレクトリのリポジトリのブランチ名の前に使用されるシンボルです。 | +| `truncation_length` | `2^63 - 1` | gitブランチをX書記素に切り捨てます。 | +| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 記号なしに「」も使用できます。 | +| `style` | `"bold purple"` | モジュールのスタイルです。 | +| `disabled` | `false` | `git_branch`モジュールを無効にします。 | ### 設定例 @@ -271,25 +350,22 @@ truncation_symbol = "" ## Git の進行状態 -`git_state`モジュールはgitディレクトリの進行状態を表します。 -例: *REBASING*, *BISECTING*, その他 - -進捗情報がある場合(例: REBASING 3/10)はその情報も表示されます。 +`git_state`モジュールはgitディレクトリの進行状態を表します。 (例: _REBASING_, _BISECTING_, その他) 進捗情報がある場合(例: REBASING 3/10)はその情報も表示されます。 ### オプション -変数 | デフォルト | 説明 ---- | --- | --- -`rebase` | `"REBASING"` | `rebase`進行中に表示されるテキストです。 -`merge` | `"MERGING"` | `merge`進行中に表示されるテキストです。 -`revert` | `"REVERTING"` | `revert`進行中に表示されるテキストです。 -`cherry_pick` | `"CHERRY-PICKING"` | `cherry-pick`進行中に表示されるテキストです。 -`bisect` | `"BISECTING"` | `bisect`進行中に表示されるテキストです。 -`am` | `"AM"` | `apply-mailbox` ( `git am` )の進行中に表示されるテキストです。 -`am_or_rebase` | `"AM/REBASE"` | あいまいな`apply-mailbox`または`rebase`が進行中のときに表示されるテキストです。 -`progress_divider` | `"/"` | 現在の進行量と合計進行量を分ける記号またはテキスト(例えば、 `" of "` 、 `"3 of 10"` )です。 -`style` | `"bold yellow"` | モジュールのスタイルです。 -`disabled` | `false` | `git_state`モジュールを無効にします。 +| 変数 | デフォルト | 説明 | +| ------------------ | ------------------ | -------------------------------------------------------- | +| `rebase` | `"REBASING"` | `rebase`進行中に表示されるテキストです。 | +| `merge` | `"MERGING"` | `merge`進行中に表示されるテキストです。 | +| `revert` | `"REVERTING"` | `revert`進行中に表示されるテキストです。 | +| `cherry_pick` | `"CHERRY-PICKING"` | `cherry-pick`進行中に表示されるテキストです。 | +| `bisect` | `"BISECTING"` | `disect`進行中に表示されるテキストです。 | +| `am` | `"AM"` | `apply-mailbox` (`git am`) の進行中に表示されるテキストです。 | +| `am_or_rebase` | `"AM/REBASE"` | あいまいな`apply-mailbox`または`rebase`が進行中のときに表示されるテキストです。 | +| `progress_divider` | `"/"` | 現在の進行量と合計進行量を分ける記号またはテキストです。 (例: `" of "` 、 `"3 of 10"`) | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | `git_state`モジュールを無効にします。 | ### 設定例 @@ -307,23 +383,23 @@ cherry_pick = "🍒 PICKING" ### オプション -変数 | デフォルト | 説明 ---- | --- | --- -`conflicted` | `"="` | このブランチにはマージの競合があります。 -`ahead` | `"⇡"` | このブランチは、追跡されるブランチよりも先にあります。 -`behind` | `"⇣"` | このブランチは、追跡されているブランチの背後にあります。 -`diverged` | `"⇕"` | このブランチは、追跡されているブランチから分岐しています。 -`untracked` | `"?"` | 作業ディレクトリに追跡されていないファイルがあります。 -`stashed` | `"$"` | ローカルリポジトリ用のスタッシュが存在します。 -`modified` | `"!"` | 作業ディレクトリにファイルの変更があります。 -`staged` | `"+"` | 新しいファイルがステージング領域に追加されました。 -`renamed` | `"»"` | 名前が変更されたファイルがステージング領域に追加されました。 -`deleted` | `"✘"` | ファイルの削除がステージング領域に追加されました。 -`show_sync_count` | `false` | 追跡されているブランチの先行/後方カウントを表示します。 -`prefix` | `[` | このモジュールの先頭に表示される文字列です。 -`suffix` | `]` | このモジュールの末尾に表示される文字列です。 -`style` | `"bold red"` | モジュールのスタイルです。 -`disabled` | `false` | `git_status`モジュールを無効にします。 +| 変数 | デフォルト | 説明 | +| ----------------- | ------------ | ------------------------------ | +| `confl |