diff options
| author | Matan Kushner <hello@matchai.dev> | 2020-11-28 23:45:59 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-28 23:45:59 -0500 |
| commit | ea6f5e429cb83c7cf690493c9c42901ea63b5838 (patch) | |
| tree | e1b6a14e2c95694b15a42c253d969c4f934f9828 /docs/ja-JP/config/README.md | |
| parent | 3dfe4ca932b80a54f1ab809d106558b003e61e0d (diff) | |
docs(i18n): New Crowdin updates (#1788)
Diffstat (limited to 'docs/ja-JP/config/README.md')
| -rw-r--r-- | docs/ja-JP/config/README.md | 607 |
1 files changed, 346 insertions, 261 deletions
diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index e8a385ff1..ce96e2713 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -33,9 +33,9 @@ PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。 $ENV:STARSHIP_CONFIG = "$HOME\.starship" ``` -### Logging +### ロギング -By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to a instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable: +デフォルトでは、Starship は警告やエラーログを `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log` という名前のファイルに出力します。このセッションキーはターミナルのインスタンスに相当します。しかし、これは `STARSHIP_CACHE` という環境変数を使って変更できます： しかし、これは `STARSHIP_CACHE` という環境変数を使って変更できます： ```sh export STARSHIP_CACHE=~/.starship/cache @@ -117,7 +117,7 @@ Starshipのほとんどのモジュールでは、表示スタイルを設定で - ( - ) -Note that `toml` has [its own escape syntax](https://github.com/toml-lang/toml#user-content-string). It is recommended to use a literal string (`''`) in your config. If you want to use a basic string (`""`), pay attention to escape the backslash `\`. +`toml` は [独自のエスケープ構文](https://github.com/toml-lang/toml#user-content-string) を持っていることに注意してください。 It is recommended to use a literal string (`''`) in your config. If you want to use a basic string (`""`), pay attention to escape the backslash `\`. For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent: @@ -215,11 +215,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -427,16 +429,17 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake if: +The `cmake` module shows the currently installed version of CMake if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file +- The current directory contains a `CMakeCache.txt` file ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🛆 "` | The symbol used before the version of cmake. | +| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `style` | `"bold blue"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `cmake` module. | @@ -464,13 +467,21 @@ preexecのような機能を必要とするBashユーザーは、 [rcalorasのba ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ----------------------------- | --------------------------- | -| `min_time` | `2_000` | 実行時間を表示する最短期間（ミリ秒単位）です。 | -| `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 | -| `format` | `"took [$duration]($style) "` | moduleのフォーマットです。 | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `false` | `cmd_duration`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | ----------------------------- | ----------------------------------------------------- | +| `min_time` | `2_000` | 実行時間を表示する最短期間（ミリ秒単位）です。 | +| `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 | +| `format` | `"took [$duration]($style) "` | moduleのフォーマットです。 | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | `cmd_duration`モジュールを無効にします。 | +| `show_notifications` | `false` | Show desktop notifications when command completes. | +| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | + +::: tip + +Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. + +::: ### 変数 @@ -493,11 +504,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -`$CONDA_DEFAULT_ENV`が設定されている場合、`conda`モジュールは現在のcondaの環境を表示します。 +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。 +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -533,7 +544,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -`crystal`モジュールには、現在インストールされているCrystalのバージョンが表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met: - カレントディレクトリに`shard.yml`ファイルが含まれている - カレントディレクトリに`.cr`の拡張子のファイルが含まれている @@ -568,7 +579,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -604,11 +615,11 @@ format = "via [🔰 $version](bold red) " ## ディレクトリ -`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在のgitリポジトリであるとルートとなります。 +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. -fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。 +When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. -例として、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/nixpkgs/pkgs`が表示されます。 +For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### オプション @@ -624,7 +635,7 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | <details> -<summary>このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。</summary> +<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> | Advanced Option | デフォルト | 説明 | | --------------------------- | ------ | ------------------------------------------------ | @@ -665,7 +676,7 @@ truncation_symbol = "…/" ## Docker Context -`docker_context`モジュールは、 [Dockerコンテキスト](https://docs.docker.com/engine/context/working-with-contexts/)が`デフォルト`に設定されていない場合、現在アクティブな <1>Dockerコンテキストを表示します。 +The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`. ### オプション @@ -698,7 +709,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -`dotnet` モジュールはカレントディレクトリに関係する.NET Core SDKのバージョンを表示します。 もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール SDKの最新のインストールバージョンを示します。 +The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. This module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -714,7 +725,7 @@ This module will only be shown in your prompt when one or more of the following You'll also need the .NET Core SDK installed in order to use it correctly. -内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`heuristic = false `を設定します。 +Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions>) when there is a csproj file in the current directory. @@ -752,7 +763,7 @@ heuristic = false ## Elixir -The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met: - カレントディレクトリに`mix.exs`ファイルが含まれている. @@ -787,7 +798,7 @@ symbol = "🔮 " ## Elm -`elm`モジュールは、現在インストールされているElmのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met: - カレントディレクトリに`elm.json`ファイルが含まれている - カレントディレクトリに`elm-package.json`ファイルが含まれている @@ -825,7 +836,7 @@ format = "via [ $version](cyan bold) " ## 環境変数 -`env_var`モジュールは、選択された環境変数の現在の値を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: - `variable`オプションが、既存の環境変数と一致する - `variable`オプションが定義されておらず、`default`オプションが定義されている @@ -862,7 +873,7 @@ default = "unknown shell" ## Erlang -The `erlang` module shows the currently installed version of Erlang/OTP. 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met: - カレントディレクトリに`rebar.config`ファイルが含まれている. - カレントディレクトリに`erlang.mk`ファイルが含まれている. @@ -871,7 +882,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. 次の | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | -------------------------------------------------------- | -| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `style` | `"bold red"` | モジュールのスタイルです。 | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `disabled` | `false` | Disables the `erlang` module. | @@ -957,24 +968,27 @@ asia-northeast1 = "an1" ## Git ブランチ -`git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。 +The `git_branch` module shows the active branch of the repo in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------- | --------------------------------------------------------------------- | -| `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | モジュールのスタイルです。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | -| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. | -| `disabled` | `false` | `git_branch`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | モジュールのスタイルです。 | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | +| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. | +| `disabled` | `false` | Disables the `git_branch` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------------------------------------------------------------------------------------- | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | +| remote | `master` | The remote branch name. | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -993,17 +1007,19 @@ truncation_symbol = "" ## Git コミット -`git_commit`モジュールは、現在のディレクトリにあるリポジトリの現在のコミットハッシュを表示します。 +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| -------------------- | -------------------------- | -------------------------------------- | -| `commit_hash_length` | `7` | 表示されるgitコミットハッシュの長さです。 | -| `format` | `'[\($hash\)]($style) '` | moduleのフォーマットです。 | -| `style` | `"bold green"` | モジュールのスタイルです。 | -| `only_detached` | `true` | 切り離されたHEAD状態のときのみgit commit hashを表示します | -| `disabled` | `false` | `git_commit`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | ------------------------------------------------------ | ------------------------------------------------- | +| `commit_hash_length` | `7` | 表示されるgitコミットハッシュの長さです。 | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | moduleのフォーマットです。 | +| `style` | `"bold green"` | モジュールのスタイルです。 | +| `only_detached` | `true` | 切り離されたHEAD状態のときのみgit commit hashを表示します | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### 変数 @@ -1020,12 +1036,13 @@ truncation_symbol = "" # ~/.config/starship.toml [git_commit] -truncation_length = 4 +commit_hash_length = 4 +tag_symbol = "🔖 " ``` ## Git の進行状態 -`git_state`モジュールはgitディレクトリの進行状態を表します。 (例: _REBASING_, _BISECTING_, その他) 進捗情報がある場合(例: REBASING 3/10)はその情報も表示されます。 +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### オプション @@ -1065,7 +1082,7 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git の状態 -`git_status`モジュールは、現在のディレクトリのリポジトリの状態を表すシンボルを表示します。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ### オプション @@ -1148,7 +1165,7 @@ behind = "⇣${count}" ## Golang -`golang`モジュールは、現在インストールされているGolangのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: - カレントディレクトリに`go.mod`ファイルが含まれている - カレントディレクトリに`go.sum`ファイルが含まれている @@ -1189,7 +1206,7 @@ format = "via [🏎💨 $version](bold cyan) " ## Helm -The `helm` module shows the currently installed version of Helm. 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met: - カレントディレクトリに`helmfile.yaml`ファイルが含まれている - The current directory contains a `Chart.yaml` file @@ -1224,7 +1241,7 @@ format = "via [⎈ $version](bold white) " ## ホスト名 -`hostname`モジュールには、システムのホスト名が表示されます。 +The `hostname` module shows the system hostname. ### オプション @@ -1259,7 +1276,7 @@ disabled = false ## Java -`java`モジュールは、現在インストールされているJavaのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: - カレントディレクトリに `pom.xml`, `build.gradle.kts`, `build.sbt` ,もしくは`.java-version`が含まれている - カレントディレクトリに拡張子が`.java`, `.class`, `.gradle`, もしくは`.jar`のファイルが含まれている @@ -1294,7 +1311,7 @@ symbol = "🌟 " ## ジョブ -`jobs`モジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 1つ以上のジョブがある、または`threshold`に指定した値以上にジョブがある場合は実行中のジョブの数を表示します。 +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. ### オプション @@ -1328,7 +1345,7 @@ threshold = 4 ## Julia -`julia`モジュールは、現在インストールされているJuliaのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: - カレントディレクトリに`Project.toml`ファイルが含まれている - カレントディレクトリに`Manifest.toml`ファイルが含まれている @@ -1368,7 +1385,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1407,7 +1424,7 @@ disabled = false ## 改行 -`line_break`モジュールは、プロンプトを2行に分割します。 +The `line_break` module separates the prompt into two lines. ### オプション @@ -1424,28 +1441,64 @@ disabled = false disabled = true ``` -## メモリ使用量 +## Lua + +The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met: + +- The current directory contains a `.lua-version` file +- The current directory contains a `lua` directory +- The current directory contains a file with the `.lua` extension + +### オプション + +| オプション | デフォルト | 説明 | +| ------------ | ---------------------------------- | -------------------------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | ---------------------- | +| version | `v5.4.0` | The version of `lua` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: この変数はスタイル文字列の一部としてのみ使用できます + +### 設定例 + +```toml +# ~/.config/starship.toml + +[lua] +format = "via [🌕 $version](bold blue) " +``` + +## Memory Usage -`memory_usage</ 0>モジュールは、現在のシステムメモリとスワップ使用量を示します。</p> +`memory_usage`モジュールは、現在のシステムメモリとスワップ使用量を示します。 -<p spaces-before="0">デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。</p> +デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。 -<p spaces-before="0">::: tip</p> +::: tip -<p spaces-before="0">このモジュールはデフォルトで無効になっています。 -有効にするには、設定ファイルで<code>disabled`を`false`に設定します。 +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------- | --------------------------------------------- | --------------------------- | -| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | -| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🐏"` | メモリ使用率を表示する前に使用される記号です。 | -| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | -| `disabled` | `true` | `memory_usage`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------- | --------------------------------------------- | --------------------------------------------------- | +| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | +| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | +| `disabled` | `true` | Disables the `memory_usage` module. | ### 変数 @@ -1467,17 +1520,14 @@ disabled = true [memory_usage] disabled = false -show_percentage = true -show_swap = true threshold = -1 symbol = " " -separator = "/" style = "bold dimmed green" ``` -## Mercurial ブランチ +## Mercurial Branch -` hg_branch `モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを示します。 +The `hg_branch` module shows the active branch of the repo in your current directory. ### オプション @@ -1513,9 +1563,9 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of Nim. 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met: -- カレントディレクトリに`nim.cfg`ファイルが含まれている +- The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1551,7 +1601,7 @@ symbol = "🎣 " ## Nix-shell -`nix_shell`モジュールは、nix-shell環境を示しています。 このモジュールは、nixシェル環境内にあるときに表示されます。 +The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. ### オプション @@ -1562,7 +1612,7 @@ symbol = "🎣 " | `style` | `"bold blue"` | モジュールのスタイルです。 | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | `nix_shell`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `nix_shell` module. | ### 変数 @@ -1589,11 +1639,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## NodeJS -`nodejs`モジュールは、現在インストールされているNodeJSのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: -- カレントディレクトリに`package.json`ファイルが含まれている +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file -- カレントディレクトリに`node_modules`ディレクトリが含まれている +- The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension @@ -1604,7 +1654,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `style` | `"bold green"` | モジュールのスタイルです。 | -| `disabled` | `false` | `nodejs`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `nodejs` module. | ### Variables @@ -1625,54 +1675,9 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' format = "via [🤖 $version](bold green) " ``` -## パッケージのバージョン - -`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. - -- **npm** – `npm`パッケージバージョンは、現在のディレクトリにある`package.json`から抽出されます -- **cargo** – `cargo`パッケージバージョンは、現在のディレクトリにある`Cargo.toml`から抽出されます。 -- **poetry** – `poetry`パッケージバージョンは、現在のディレクトリにある`pyproject.toml`から抽出されます -- **composer** – `composer`パッケージバージョンは、現在のディレクトリにある`composer.json`から抽出されます -- **gradle** – The `gradle` package version is extracted from the `build.gradle` present -- **julia** - The package version is extracted from the `Project.toml` present -- **mix** - The `mix` package version is extracted from the `mix.exs` present -- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present -- **maven** - The `maven` package version is extracted from the `pom.xml` present - -> ⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。 - -### オプション - -| オプション | デフォルト | 説明 | -| ----------------- | ---------------------------------- | --------------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"📦 "` | パッケージのバージョンを表示する前に使用される記号です。 | -| `style` | `"bold 208"` | モジュールのスタイルです。 | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | `package` モジュールを無効にします。 | - -### 変数 - -| 変数 | 設定例 | 説明 | -| --------- | -------- | --------------------------- | -| version | `v1.0.0` | The version of your package | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | - -\*: この変数はスタイル文字列の一部としてのみ使用できます - -### 設定例 - -```toml -# ~/.config/starship.toml - -[package] -format = "via [🎁 $version](208 bold) " -``` - ## OCaml -The `ocaml` module shows the currently installed version of OCaml. 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met: - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -1709,9 +1714,89 @@ The `ocaml` module shows the currently installed version of OCaml. 次の条件 format = "via [🐪 $version]($style) " ``` +## OpenStack + +The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. + +### オプション + +| オプション | デフォルト | 説明 | +| ---------- | --------------------------------------------------- | -------------------------------------------------------------- | +| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `OpenStack` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | ------ | ----------------------------- | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: この変数はスタイル文字列の一部としてのみ使用できます + +### 設定例 + +```toml +# ~/.config/starship.toml + +[openstack] +format = "on [$symbol$cloud(\\($project\\))]($style) " +style = "bold yellow" +symbol = "☁️ " +``` + +## Package Version + +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. + +- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory +- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory +- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory +- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory +- **gradle** – The `gradle` package version is extracted from the `build.gradle` present +- **julia** - The package version is extracted from the `Project.toml` present +- **mix** - The `mix` package version is extracted from the `mix.exs` present +- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present +- **maven** - The `maven` package version is extracted from the `pom.xml` present + +> ⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。 + +### オプション + +| オプション | デフォルト | 説明 | +| ----------------- | ---------------------------------- | ---------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `style` | `"bold 208"` | モジュールのスタイルです。 | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | + +### 変数 + +| 変数 | 設定 |