mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-11-28 07:46:28 +00:00
docs: alphabetize modules in config docs (#981)
This commit is contained in:
Mick Hohmann
GitHub
parent
950f976ac7
commit
be72797fd2
@ -329,6 +329,32 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
|
|||||||
style = "dimmed green"
|
style = "dimmed green"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Crystal
|
||||||
|
|
||||||
|
The `crystal` module shows the currently installed version of Crystal.
|
||||||
|
The module will be shown if any of the following conditions are met:
|
||||||
|
|
||||||
|
- The current directory contains a `shard.yml` file
|
||||||
|
- The current directory contains a `.cr` file
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Variable | Default | Description |
|
||||||
|
| ---------- | ------------ | --------------------------------------------------------- |
|
||||||
|
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
||||||
|
| `style` | `"bold red"` | The style for the module. |
|
||||||
|
| `disabled` | `false` | Disables the `crystal` module. |
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
[crystal]
|
||||||
|
symbol = "✨ "
|
||||||
|
style = "bold blue"
|
||||||
|
```
|
||||||
|
|
||||||
## Directory
|
## Directory
|
||||||
|
|
||||||
The `directory` module shows the path to your current directory, truncated to
|
The `directory` module shows the path to your current directory, truncated to
|
||||||
@ -413,6 +439,29 @@ style = "green"
|
|||||||
heuristic = false
|
heuristic = false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Elixir
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
- The current directory contains a `mix.exs` file.
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Variable | Default | Description |
|
||||||
|
| ---------- | ------- | --------------------------------------------------------------- |
|
||||||
|
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||||
|
| `disabled` | `false` | Disables the `elixir` module. |
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
[elixir]
|
||||||
|
symbol = "🔮 "
|
||||||
|
```
|
||||||
|
|
||||||
## Elm
|
## Elm
|
||||||
|
|
||||||
The `elm` module shows the currently installed version of Elm.
|
The `elm` module shows the currently installed version of Elm.
|
||||||
@ -471,29 +520,6 @@ variable = "SHELL"
|
|||||||
default = "unknown shell"
|
default = "unknown shell"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Elixir
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
- The current directory contains a `mix.exs` file.
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
| Variable | Default | Description |
|
|
||||||
| ---------- | ------- | --------------------------------------------------------------- |
|
|
||||||
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
|
|
||||||
| `disabled` | `false` | Disables the `elixir` module. |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# ~/.config/starship.toml
|
|
||||||
|
|
||||||
[elixir]
|
|
||||||
symbol = "🔮 "
|
|
||||||
```
|
|
||||||
|
|
||||||
## Git Branch
|
## Git Branch
|
||||||
|
|
||||||
The `git_branch` module shows the active branch of the repo in your current directory.
|
The `git_branch` module shows the active branch of the repo in your current directory.
|
||||||
@ -689,31 +715,6 @@ The module will be shown if any of the following conditions are met:
|
|||||||
symbol = " "
|
symbol = " "
|
||||||
```
|
```
|
||||||
|
|
||||||
## Mercurial Branch
|
|
||||||
|
|
||||||
The `hg_branch` module shows the active branch of the repo in your current directory.
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
| Variable | Default | Description |
|
|
||||||
| ------------------- | --------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
|
||||||
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
|
||||||
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
|
||||||
| `style` | `"bold purple"` | The style for the module. |
|
|
||||||
| `disabled` | `true` | Disables the `hg_branch` module. |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# ~/.config/starship.toml
|
|
||||||
|
|
||||||
[hg_branch]
|
|
||||||
symbol = "🌱 "
|
|
||||||
truncation_length = 4
|
|
||||||
truncation_symbol = ""
|
|
||||||
```
|
|
||||||
|
|
||||||
## Hostname
|
## Hostname
|
||||||
|
|
||||||
The `hostname` module shows the system hostname.
|
The `hostname` module shows the system hostname.
|
||||||
@ -742,6 +743,31 @@ trim_at = ".companyname.com"
|
|||||||
disabled = false
|
disabled = false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 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` or `build.sbt` file
|
||||||
|
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Variable | Default | Description |
|
||||||
|
| ---------- | -------------- | ------------------------------------------------------ |
|
||||||
|
| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
|
||||||
|
| `style` | `"dimmed red"` | The style for the module. |
|
||||||
|
| `disabled` | `false` | Disables the `java` module. |
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
[java]
|
||||||
|
symbol = "🌟 "
|
||||||
|
```
|
||||||
|
|
||||||
## Jobs
|
## Jobs
|
||||||
|
|
||||||
The `jobs` module shows the current number of jobs running.
|
The `jobs` module shows the current number of jobs running.
|
||||||
@ -820,58 +846,6 @@ The `line_break` module separates the prompt into two lines.
|
|||||||
disabled = true
|
disabled = true
|
||||||
```
|
```
|
||||||
|
|
||||||
## Nix-shell
|
|
||||||
|
|
||||||
The `nix_shell` module shows the nix-shell environment.
|
|
||||||
The module will be shown when inside a nix-shell environment.
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
| Variable | Default | Description |
|
|
||||||
| ------------ | ------------ | ---------------------------------- |
|
|
||||||
| `use_name` | `false` | Display the name of the nix-shell. |
|
|
||||||
| `impure_msg` | `"impure"` | Customize the "impure" msg. |
|
|
||||||
| `pure_msg` | `"pure"` | Customize the "pure" msg. |
|
|
||||||
| `style` | `"bold red"` | The style for the module. |
|
|
||||||
| `disabled` | `false` | Disables the `nix_shell` module. |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# ~/.config/starship.toml
|
|
||||||
|
|
||||||
[nix_shell]
|
|
||||||
disabled = true
|
|
||||||
use_name = true
|
|
||||||
impure_msg = "impure shell"
|
|
||||||
pure_msg = "pure shell"
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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` or `build.sbt` file
|
|
||||||
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
| Variable | Default | Description |
|
|
||||||
| ---------- | -------------- | ------------------------------------------------------ |
|
|
||||||
| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
|
|
||||||
| `style` | `"dimmed red"` | The style for the module. |
|
|
||||||
| `disabled` | `false` | Disables the `java` module. |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# ~/.config/starship.toml
|
|
||||||
|
|
||||||
[java]
|
|
||||||
symbol = "🌟 "
|
|
||||||
```
|
|
||||||
|
|
||||||
## Memory Usage
|
## Memory Usage
|
||||||
|
|
||||||
The `memory_usage` module shows current system memory and swap usage.
|
The `memory_usage` module shows current system memory and swap usage.
|
||||||
@ -911,30 +885,56 @@ separator = "/"
|
|||||||
style = "bold dimmed green"
|
style = "bold dimmed green"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Crystal
|
## Mercurial Branch
|
||||||
|
|
||||||
The `crystal` module shows the currently installed version of Crystal.
|
The `hg_branch` module shows the active branch of the repo in your current directory.
|
||||||
The module will be shown if any of the following conditions are met:
|
|
||||||
|
|
||||||
- The current directory contains a `shard.yml` file
|
|
||||||
- The current directory contains a `.cr` file
|
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Variable | Default | Description |
|
| Variable | Default | Description |
|
||||||
| ---------- | ------------ | --------------------------------------------------------- |
|
| ------------------- | --------------- | -------------------------------------------------------------------------------------------- |
|
||||||
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
|
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
|
||||||
| `style` | `"bold red"` | The style for the module. |
|
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes |
|
||||||
| `disabled` | `false` | Disables the `crystal` module. |
|
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
|
||||||
|
| `style` | `"bold purple"` | The style for the module. |
|
||||||
|
| `disabled` | `true` | Disables the `hg_branch` module. |
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# ~/.config/starship.toml
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
[crystal]
|
[hg_branch]
|
||||||
symbol = "✨ "
|
symbol = "🌱 "
|
||||||
style = "bold blue"
|
truncation_length = 4
|
||||||
|
truncation_symbol = ""
|
||||||
|
```
|
||||||
|
|
||||||
|
## Nix-shell
|
||||||
|
|
||||||
|
The `nix_shell` module shows the nix-shell environment.
|
||||||
|
The module will be shown when inside a nix-shell environment.
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Variable | Default | Description |
|
||||||
|
| ------------ | ------------ | ---------------------------------- |
|
||||||
|
| `use_name` | `false` | Display the name of the nix-shell. |
|
||||||
|
| `impure_msg` | `"impure"` | Customize the "impure" msg. |
|
||||||
|
| `pure_msg` | `"pure"` | Customize the "pure" msg. |
|
||||||
|
| `style` | `"bold red"` | The style for the module. |
|
||||||
|
| `disabled` | `false` | Disables the `nix_shell` module. |
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
[nix_shell]
|
||||||
|
disabled = true
|
||||||
|
use_name = true
|
||||||
|
impure_msg = "impure shell"
|
||||||
|
pure_msg = "pure shell"
|
||||||
```
|
```
|
||||||
|
|
||||||
## NodeJS
|
## NodeJS
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user