haskal
/
starship
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Update defaults in config docs (#1759) 

Have updated some of the config docs to correct the git_status default
that was incorrect. Have also taken the time to switch some of the
format strings to use toml literal strings rather than normal strings to
simplify the escape strings.
This commit is contained in:
Thomas O'Donnell 2020-10-12 06:10:39 +02:00 committed by GitHub
parent e7a83aa445
commit 9044f9e14c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 102 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

199
docs/config/README.md
View File

@ -246,13 +246,13 @@ is read from the `AWS_VAULT` env var.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | | ---------------- | ---------------------------------------------- | --------------------------------------------------------------- |
| `format` | `"on [$symbol$profile(\\($region\\))]($style) "` | The format for the module. | | `format` | `'on [$symbol$profile(\($region\))]($style) '` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
### Variables ### Variables
@ -273,7 +273,7 @@ is read from the `AWS_VAULT` env var.
# ~/.config/starship.toml # ~/.config/starship.toml
[aws] [aws]
format = "on [$symbol$profile(\\($region\\))]($style) " format = 'on [$symbol$profile(\($region\))]($style) '
style = "bold blue" style = "bold blue"
symbol = "🅰 " symbol = "🅰 "
[aws.region_aliases] [aws.region_aliases]
@ -360,7 +360,7 @@ style = "bold red"
The `display` option is an array of the following table. The `display` option is an array of the following table.
| Variable | Description | | Option | Description |
| ----------- | ----------------------------------------------- | | ----------- | ----------------------------------------------- |
| `threshold` | The upper bound for the display option. | | `threshold` | The upper bound for the display option. |
| `style` | The style used if the display option is in use. | | `style` | The style used if the display option is in use. |
@ -600,7 +600,7 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------------- | | ---------- | ---------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
@ -642,7 +642,7 @@ it would have been `nixpkgs/pkgs`.
### Options ### Options
| Variable | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | | `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | | `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
@ -804,12 +804,12 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------------------------------------------- | --------------------------------------------------------------- | | ---------- | ------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. | | `style` | `"bold purple"` | The style for the module. |
| `format` | `"via [$symbol$version \\(OTP $otp_version\\)]($style) "` | The format for the module elixir. | | `format` | `'via [$symbol$version \(OTP $otp_version\)]($style) '` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. | | `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -951,13 +951,13 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc
### Options ### Options
| Variable | Default | Description | | Option | Default | Description |
| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | | ---------------- | ---------------------------------------------- | --------------------------------------------------------------- |
| `format` | `"on [$symbol$account(\\($region\\))]($style) "` | The format for the module. | | `format` | `'on [$symbol$account(\($region\))]($style) '` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | | Table of region aliases to display in addition to the GCP name. |
| `style` | `"bold blue"` | The style for the module. | | `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
### Variables ### Variables
@ -980,7 +980,7 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc
# ~/.config/starship.toml # ~/.config/starship.toml
[gcloud] [gcloud]
format = "on [$symbol$account(\\($project\\))]($style) " format = 'on [$symbol$account(\($project\))]($style) '
``` ```
#### Display active config name only #### Display active config name only
@ -1047,13 +1047,13 @@ The `git_commit` module shows the current commit hash of the repo in your curren
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------- | ----------------------------------------------------- | | -------------------- | ------------------------ | ----------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `"[\\($hash\\)]($style) "` | The format for the module. | | `format` | `'[\($hash\)]($style) '` | The format for the module. |
| `style` | `"bold green"` | The style for the module. | | `style` | `"bold green"` | The style for the module. |
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | | `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
| `disabled` | `false` | Disables the `git_commit` module. | | `disabled` | `false` | Disables the `git_commit` module. |
### Variables ### Variables
@ -1082,18 +1082,18 @@ that information will be shown too.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | -------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | | `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. |
| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | | `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. |
| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | | `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. |
| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | | `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. |
| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | | `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. |
| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | | `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. |
| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `format` | `"\\([$state( $progress_current/$progress_total)]($style)\\) "` | The format for the module. | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. |
| `disabled` | `false` | Disables the `git_state` module. | | `disabled` | `false` | Disables the `git_state` module. |
### Variables ### Variables
@ -1112,7 +1112,7 @@ that information will be shown too.
# ~/.config/starship.toml # ~/.config/starship.toml
[git_state] [git_state]
format = "[\\($state( $progress_current of $progress_total)\\)]($style) " format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = "[🍒 PICKING](bold red)" cherry_pick = "[🍒 PICKING](bold red)"
``` ```
@ -1123,21 +1123,21 @@ current directory.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ------------------------------------------- | ----------------------------------- | | ------------ | --------------------------------------------- | ----------------------------------- |
| `format` | `"[\[$all_status$ahead_behind\]]($style) "` | The default format for `git_status` | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
| `conflicted` | `"="` | This branch has merge conflicts. | | `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | The format of `ahead` | | `ahead` | `"⇡"` | The format of `ahead` |
| `behind` | `"⇣"` | The format of `behind` | | `behind` | `"⇣"` | The format of `behind` |
| `diverged` | `"⇕"` | The format of `diverged` | | `diverged` | `"⇕"` | The format of `diverged` |
| `untracked` | `"?"` | The format of `untracked` | | `untracked` | `"?"` | The format of `untracked` |
| `stashed` | `"$"` | The format of `stashed` | | `stashed` | `"$"` | The format of `stashed` |
| `modified` | `"!"` | The format of `modified` | | `modified` | `"!"` | The format of `modified` |
| `staged` | `"+"` | The format of `staged` | | `staged` | `"+"` | The format of `staged` |
| `renamed` | `"»"` | The format of `renamed` | | `renamed` | `"»"` | The format of `renamed` |
| `deleted` | `"✘"` | The format of `deleted` | | `deleted` | `"✘"` | The format of `deleted` |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
### Variables ### Variables
@ -1439,14 +1439,13 @@ To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ----------------------- | -------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. |
| `format` | `"[$symbol$context( \\($namespace\\))]($style) in "` | The format for the module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. | | `style` | `"cyan bold"` | The style for the module. |
| `namespace_spaceholder` | `none` | The value to display if no namespace was found. | | `context_aliases` | | Table of context aliases to display. |
| `context_aliases` | | Table of context aliases to display. | | `disabled` | `true` | Disables the `kubernetes` module. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables ### Variables
@ -1465,7 +1464,7 @@ To enable it, set `disabled` to `false` in your configuration file.
# ~/.config/starship.toml # ~/.config/starship.toml
[kubernetes] [kubernetes]
format = "on [⛵ $context \\($namespace\\)](dimmed green) " format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false disabled = false
[kubernetes.context_aliases] [kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev" "dev.local.cluster.k8s" = "dev"
@ -1624,14 +1623,14 @@ The module will be shown when inside a nix-shell environment.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------ | -------------------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$state( \\($name\\))]($style) "` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | | `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. |
| `style` | `"bold blue"` | The style for the module. | | `style` | `"bold blue"` | The style for the module. |
| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. |
| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. |
| `disabled` | `false` | Disables the `nix_shell` module. | | `disabled` | `false` | Disables the `nix_shell` module. |
### Variables ### Variables
@ -1653,7 +1652,7 @@ The module will be shown when inside a nix-shell environment.
disabled = true disabled = true
impure_msg = "[impure shell](bold red)" impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)" pure_msg = "[pure shell](bold green)"
format = "via [☃️ $state( \\($name\\))](bold blue) " format = 'via [☃️ $state( \($name\))](bold blue) '
``` ```
## NodeJS ## NodeJS
@ -1800,7 +1799,7 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------------------- | | ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
@ -1883,16 +1882,16 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | -------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `format` | `"via [${symbol}${pyenv_prefix}${version}( \\($virtualenv\\))]($style) "` | The format for the module. | | `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv ` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv ` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | | `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `python` module. | | `disabled` | `false` | Disables the `python` module. |
### Variables ### Variables
@ -2007,7 +2006,7 @@ set to a number and meets or exceeds the specified threshold.
### Options ### Options
| Variable | Default | Description | | Option | Default | Description |
| ----------- | ---------------------------- | --------------------------------------- | | ----------- | ---------------------------- | --------------------------------------- |
| `threshold` | `2` | Display threshold. | | `threshold` | `2` | Display threshold. |
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | | `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
@ -2043,12 +2042,12 @@ and `$SINGULARITY_NAME` is set.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | -------------------------------- | ------------------------------------------------ | | ---------- | ------------------------------ | ------------------------------------------------ |
| `format` | `"[$symbol\\[$env\\]]($style) "` | The format for the module. | | `format` | `'[$symbol\[$env\]]($style) '` | The format for the module. |
| `symbol` | `""` | A format string displayed before the image name. | | `symbol` | `""` | A format string displayed before the image name. |
| `style` | `"bold dimmed blue"` | The style for the module. | | `style` | `"bold dimmed blue"` | The style for the module. |
| `disabled` | `false` | Disables the `singularity` module. | | `disabled` | `false` | Disables the `singularity` module. |
### Variables ### Variables
@ -2066,7 +2065,7 @@ and `$SINGULARITY_NAME` is set.
# ~/.config/starship.toml # ~/.config/starship.toml
[singularity] [singularity]
format = "[📦 \\[$env\\]]($style) " format = '[📦 \[$env\]]($style) '
``` ```
## Swift ## Swift
@ -2118,7 +2117,7 @@ To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Variable | Default | Description | | Option | Default | Description |
| ---------- | --------------------------- | ------------------------------------------------------ | | ---------- | --------------------------- | ------------------------------------------------------ |
| `format` | `[$symbol$status]($style) ` | The format of the module | | `format` | `[$symbol$status]($style) ` | The format of the module |
| `symbol` | `"✖"` | A format string representing the symbol for the status | | `symbol` | `"✖"` | A format string representing the symbol for the status |
@ -2144,7 +2143,7 @@ To enable it, set `disabled` to `false` in your configuration file.
[status] [status]
style = "bg:blue" style = "bg:blue"
symbol = "💣 " symbol = "💣 "
format = "[\\[$symbol$status\\]]($style) " format = '[\[$symbol$status\]]($style) '
disabled = false disabled = false
``` ```
@ -2242,7 +2241,7 @@ Manually setting `time_format` will override the `use_12hr` setting.
[time] [time]
disabled = false disabled = false
format = "🕙[\\[ $time \\]]($style) " format = '🕙[\[ $time \]]($style) '
time_format = "%T" time_format = "%T"
utc_time_offset = "-5" utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"

6
docs/migrating-to-0.45.0/README.md
View File

@ -168,7 +168,7 @@ error_symbol = "[✖](bold red)"
[git_commit] [git_commit]
-- prefix = "(" -- prefix = "("
-- suffix = ")" -- suffix = ")"
++ format = "[\\($hash\\)]($style) " ++ format = '[\($hash\)]($style) '
``` ```
#### Git Status #### Git Status
@ -186,7 +186,7 @@ error_symbol = "[✖](bold red)"
-- prefix = "[" -- prefix = "["
-- suffix = "]" -- suffix = "]"
-- show_sync_count = false -- show_sync_count = false
++ format = "[\\[$all_status$ahead_behind\\]]($style)" ++ format = '([\[$all_status$ahead_behind\]]($style) )'
``` ```
Previously, the `show_sync_count` property was used to configure the prompt to Previously, the `show_sync_count` property was used to configure the prompt to
@ -234,7 +234,7 @@ behind = "⇣${count}"
[singularity] [singularity]
-- prefix = "" -- prefix = ""
-- suffix = "" -- suffix = ""
++ format = "[$symbol\\[$env\\]]($style) " ++ format = '[$symbol\[$env\]]($style) '
``` ```
#### Time #### Time