summaryrefslogtreecommitdiffstats
path: root/docs/zh-TW/config/README.md
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.dev>2020-11-28 23:45:59 -0500
committerGitHub <noreply@github.com>2020-11-28 23:45:59 -0500
commitea6f5e429cb83c7cf690493c9c42901ea63b5838 (patch)
treee1b6a14e2c95694b15a42c253d969c4f934f9828 /docs/zh-TW/config/README.md
parent3dfe4ca932b80a54f1ab809d106558b003e61e0d (diff)
docs(i18n): New Crowdin updates (#1788)
Diffstat (limited to 'docs/zh-TW/config/README.md')
-rw-r--r--docs/zh-TW/config/README.md564
1 files changed, 325 insertions, 239 deletions
diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md
index f38d1527d..3761278f8 100644
--- a/docs/zh-TW/config/README.md
+++ b/docs/zh-TW/config/README.md
@@ -214,11 +214,13 @@ $conda\
$memory_usage\
$aws\
$gcloud\
+$openstack\
$env_var\
$crystal\
$cmd_duration\
$custom\
$line_break\
+$lua\
$jobs\
$battery\
$time\
@@ -426,16 +428,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
### 選項
| Option | 預設 | 說明 |
| ---------- | ---------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the 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. |
@@ -463,13 +466,21 @@ The `cmake` module shows the currently installed version of CMake if:
### 選項
-| Option | 預設 | 說明 |
-| ------------------- | ----------------------------- | ----------------------------------------------------- |
-| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
-| `show_milliseconds` | `false` | 顯示時間除了以秒為單位外,亦以毫秒顯示 |
-| `format` | `"took [$duration]($style) "` | The format for the module. |
-| `style` | `"bold yellow"` | 這個模組的風格。 |
-| `disabled` | `false` | 停用 `cmd_duration` 模組。 |
+| Option | 預設 | 說明 |
+| -------------------- | ----------------------------- | ----------------------------------------------------- |
+| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
+| `show_milliseconds` | `false` | 顯示時間除了以秒為單位外,亦以毫秒顯示 |
+| `format` | `"took [$duration]($style) "` | The format for the 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`.
+
+:::
### Variables
@@ -492,7 +503,7 @@ 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
@@ -532,7 +543,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`檔案
@@ -567,7 +578,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
@@ -603,11 +614,11 @@ format = "via [🔰 $version](bold red) "
## 資料夾
-`directory` 模組顯示到現在資料夾的路徑,並裁減到前三層資料夾。 你的資料夾也會被裁減到你所在的 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`。 你會看到 `~/D/N/nixpkgs/pkgs`,而在這個設定之前則是 `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`.
### 選項
@@ -623,7 +634,7 @@ format = "via [🔰 $version](bold red) "
| `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 | 預設 | 說明 |
| --------------------------- | ------ | ------------------------------------------------ |
@@ -697,7 +708,7 @@ format = "via [🐋 $context](blue bold)"
## Dotnet
-`dotnet` 模組顯示現在資料夾使用的 .NET Core SDK 的版本。 如果這個資料夾已經選定一個 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:
@@ -713,7 +724,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` 的兩倍快,但是它可能會在你的 .NET 專案有不尋常的資料夾結構時顯示不正確的版本。 如果精確度比速度更重要的話,你可以藉由設定模組中的 `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.
@@ -751,7 +762,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` 檔案.
@@ -786,7 +797,7 @@ symbol = "🔮 "
## Elm
-The `elm` module shows the currently installed version of 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` 檔案
@@ -824,7 +835,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` 選項。
@@ -861,7 +872,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` 檔案.
@@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. 這個
| Option | 預設 | 說明 |
| ---------- | ---------------------------------- | -------------------------------------------------------- |
-| `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) "` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. |
@@ -956,24 +967,27 @@ asia-northeast1 = "an1"
## Git 分支
-`git_branch` 模組顯示現在的資料夾中使用中的儲存庫的分支。
+The `git_branch` module shows the active branch of the repo in your current directory.
### 選項
-| Option | 預設 | 說明 |
-| ------------------- | -------------------------------- | ------------------------------------------------------------------------------- |
-| `format` | `"on [$symbol$branch]($style) "` | The format for the 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` 模組。 |
+| Option | 預設 | 說明 |
+| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ |
+| `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) "` | The format for the 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. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ---------------------------------------------------------------------------------------------------- |
| 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 | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
@@ -992,17 +1006,19 @@ truncation_symbol = ""
## Git Commit
-The `git_commit` module shows the current commit hash of the repo in your current directory.
+The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
### 選項
-| Option | 預設 | 說明 |
-| -------------------- | -------------------------- | ----------------------------------------------------- |
-| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
-| `format` | `'[\($hash\)]($style) '` | The format for the module. |
-| `style` | `"bold green"` | 這個模組的風格。 |
-| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
-| `disabled` | `false` | Disables the `git_commit` module. |
+| Option | 預設 | 說明 |
+| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
+| `commit_hash_length` | `7` | The length of the displayed git commit hash. |
+| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
+| `style` | `"bold green"` | 這個模組的風格。 |
+| `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
+| `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. |
### Variables
@@ -1020,11 +1036,12 @@ The `git_commit` module shows the current commit hash of the repo in your curren
[git_commit]
commit_hash_length = 4
+tag_symbol = "🔖 "
```
## Git State
-`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.
### 選項
@@ -1064,7 +1081,7 @@ cherry_pick = "[🍒 PICKING](bold red)"
## Git Status
-`git_status` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。
+The `git_status` module shows symbols representing the state of the repo in your current directory.
### 選項
@@ -1147,7 +1164,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` 檔案
@@ -1188,7 +1205,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
@@ -1223,7 +1240,7 @@ format = "via [⎈ $version](bold white) "
## 主機名稱
-`hostname` 模組顯示系統的主機名稱。
+The `hostname` module shows the system hostname.
### 選項
@@ -1258,7 +1275,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:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
@@ -1293,7 +1310,7 @@ symbol = "🌟 "
## 工作
-`jobs` 模組顯示現在正在執行中的工作。 這個模組只會在有背景工作正在執行時顯示。 這個模組會在工作數量超過一個,或者有設定 `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.
### 選項
@@ -1327,7 +1344,7 @@ threshold = 4
## Julia
-The `julia` module shows the currently installed version of Julia. 這個模組在下列其中一個條件達成時顯示:
+The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file
@@ -1367,7 +1384,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.
:::
@@ -1406,7 +1423,7 @@ disabled = false
## 換行
-`line_break` 模組將提示字元分成兩行。
+The `line_break` module separates the prompt into two lines.
### 選項
@@ -1423,27 +1440,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
+
+### 選項
+
+| Option | 預設 | 說明 |
+| ------------ | ---------------------------------- | -------------------------------------------------------------------------- |
+| `format` | `"via [$symbol$version]($style) "` | The format for the 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. |
-`memory_usage` 模組顯示現在系統記憶體與 swap 的使用量。
+### Variables
-預設 swap 使用量會在系統總 swap 使用量不為 0 時顯示出來。
+| 變數 | 範例 | 說明 |
+| --------- | -------- | ------------------------------------ |
+| version | `v5.4.0` | The version of `lua` |
+| symbol | | Mirrors the value of option `symbol` |
+| style\* | | Mirrors the value of option `style` |
+
+\*: This variable can only be used as a part of a style string
+
+### 範例
+
+```toml
+# ~/.config/starship.toml
+
+[lua]
+format = "via [🌕 $version](bold blue) "
+```
+
+## Memory Usage
+
+The `memory_usage` module shows current system memory and swap usage.
+
+By default the swap usage is displayed if the total system swap is non-zero.
::: tip
-這個模組預設是停用的。 想要啟用它的話,請在設定檔中將 `disabled` 設定為 `false`。
+This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
:::
### 選項
-| Option | 預設 | 說明 |
-| ----------- | --------------------------------------------- | -------------------------- |
-| `threshold` | `75` | 將記憶體使用量隱藏,除非使用量超過指定值。 |
-| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. |
-| `symbol` | `"🐏"` | 顯示在記憶體使用量之前的符號。 |
-| `style` | `"bold dimmed white"` | 這個模組的風格。 |
-| `disabled` | `true` | 停用 `memory_usage` 模組。 |
+| Option | 預設 | 說明 |
+| ----------- | --------------------------------------------- | -------------------------------------------------------- |
+| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
+| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. |
+| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. |
+| `style` | `"bold dimmed white"` | 這個模組的風格。 |
+| `disabled` | `true` | Disables the `memory_usage` module. |
### Variables
@@ -1465,11 +1519,8 @@ disabled = true
[memory_usage]
disabled = false
-show_percentage = true
-show_swap = true
threshold = -1
symbol = " "
-separator = "/"
style = "bold dimmed green"
```
@@ -1511,9 +1562,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
@@ -1549,7 +1600,7 @@ symbol = "🎣 "
## Nix-shell
-`nix_shell` 模組顯示 nix-shell 環境。 這個模組會在 nix-shell 環境中顯示。
+The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
### 選項
@@ -1560,7 +1611,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. |
### Variables
@@ -1587,11 +1638,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
@@ -1602,7 +1653,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
| `style` | `"bold green"` | 這個模組的風格。 |
-| `disabled` | `false` | 停用 `nodejs` 模組。 |
+| `disabled` | `false` | Disables the `nodejs` module. |
###  Variables
@@ -1623,54 +1674,9 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
format = "via [🤖 $version](bold green) "
```
-## 套件版本
-
-The `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** – 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
-
-> ⚠️ 顯示出來的版本是從你的現在資料夾之中擷取出來的,並非從套件管理員取得。
-
-### 選項
-
-| Option | 預設 | 說明 |
-| ----------------- | ---------------------------------- | --------------------------------------------------------- |
-| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
-| `symbol` | `"📦 "` | 顯示在套件的版本之前的符號。 |
-| `style` | `"bold 208"` | 這個模組的風格。 |
-| `display_private` | `false` | Enable displaying version for packages marked as private. |
-| `disabled` | `false` | 停用 `package` 模組。 |
-
-### Variables
-
-| 變數 | 範例 | 說明 |
-| --------- | -------- | ------------------------------------ |
-| version | `v1.0.0` | The version of your package |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
-
-\*: This variable can only be used as a part of a style string
-
-### 範例
-
-```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
@@ -1707,9 +1713,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.
+
+### 選項
+
+| Option | 預設 | 說明 |
+| ---------- | --------------------------------------------------- | -------------------------------------------------------------- |
+| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
+| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
+| `style` | `"bold yellow"` | 這個模組的風格。 |
+| `disabled` | `false` | Disables the `OpenStack` module. |
+
+### Variables
+
+| 變數 | 範例 | 說明 |
+| --------- | ------ | ------------------------------------ |
+| cloud | `corp` | The current OpenStack cloud |
+| project | `dev` | The current OpenStack project |
+| symbol | | Mirrors the value of option `symbol` |
+| style\* | | Mirrors the value of option `style` |
+
+\*: This variable can only be used as a part of a style string
+
+### 範例
+
+```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
+
+> ⚠️ 顯示出來的版本是從你的現在資料夾之中擷取出來的,並非從套件管理員取得。
+
+### 選項
+
+| Option | 預設 | 說明 |
+| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
+| `format` | `"via [$symbol$version]($style) "` | The format for the 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. |
+
+### Variables
+
+| 變數 | 範例 | 說明 |
+| --------- | -------- | ------------------------------------ |
+| version | `v1.0.0` | The version of your package |
+| symbol | | Mirrors the value of option `symbol` |
+| style\* | | Mirrors the value of option `style` |
+
+\*: This variable can only be used as a part of a style string
+
+### 範例
+
+```toml
+# ~/.config/starship.toml
+
+[package]
+format = "via [🎁 $version](208 bold) "
+```
+
## Perl
-The `perl` module shows the currently installed version of Perl. 這個模組在下列其中一個條件達成時顯示:
+The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@@ -1745,9 +1831,9 @@ format = "via [🦪 $version]($style) "
## PHP
-The `php` module shows the currently installed version of PHP. 這個模組在下列其中一個條件達成時顯示:
+The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met:
-- 現在資料夾中包含一個 `composer.json` 檔案
+- The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file
- The current directory contains a `.php` file
@@ -1779,21 +1865,56 @@ The `php` module shows the currently installed version of PHP. 這個模組在
format = "via [🔹 $version](147 bold) "
```
+## PureScript
+
+The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
+
+- The current directory contains a `spago.dhall` file
+- The current directory contains a \*.purs files
+
+### 選項
+
+| Option | 預設 | 說明 |
+| ---------- | ---------------------------------- | ------------------------------------------------------------ |
+| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
+| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
+| `style` | `"bold white"` | 這個模組的風格。 |
+| `disabled` | `false` | Disables the `purescript` module. |
+
+### Variables
+
+| 變數 | 範例 | 說明 |
+| --------- | -------- | ------------------------------------ |
+| version | `0.13.5` | The version of `purescript` |
+| symbol | | Mirrors the value of option `symbol` |
+| style\* | | Mirrors the value of option `style` |
+
+\*: This variable can only be used as a part of a style string
+
+### 範例
+
+```toml
+# ~/.config/starship.toml
+
+[purescript]
+format = "via [$symbol$version](bold white)"
+```
+
## Python
The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated.
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.
-這個模組在下列其中一個條件達成時顯示:
+The module will be shown if any of the following conditions are met:
-- 目前資料夾中有一個 `.python-version` 檔案
-- 目前資料夾中有一個 `requirements.txt` 檔案
-- 目前資料夾中有一個 `pyproject.toml` 檔案
+- The current directory contains a `.python-version` file
+- The current directory contains a `requirements.txt` file
+- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
-- 目前資料夾中有一個 `Pipfile` 檔案
-- 目前資料夾中有一個 `tox.ini` 檔案
-- 現在資料夾中包含一個 `setup.py` 檔案
+- The current directory contains a `Pipfile` file
+- The current directory contains a `tox.ini` file
+- The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file
- A virtual environment is currently activated
@@ -1804,11 +1925,11 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name
| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | 這個模組的風格。 |
-| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 |
+| `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true`