From be72797fd2cafd8f43094900001830d05977f937 Mon Sep 17 00:00:00 2001 From: Mick Hohmann Date: Mon, 16 Mar 2020 02:07:08 +0100 Subject: [PATCH] docs: alphabetize modules in config docs (#981) --- docs/config/README.md | 228 +++++++++++++++++++++--------------------- 1 file changed, 114 insertions(+), 114 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 75b04009..89d9bfd3 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -329,6 +329,32 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c 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 The `directory` module shows the path to your current directory, truncated to @@ -413,6 +439,29 @@ style = "green" 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 The `elm` module shows the currently installed version of Elm. @@ -471,29 +520,6 @@ variable = "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 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 = " " ``` -## 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 The `hostname` module shows the system hostname. @@ -742,6 +743,31 @@ trim_at = ".companyname.com" 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 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 ``` -## 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 The `memory_usage` module shows current system memory and swap usage. @@ -911,30 +885,56 @@ separator = "/" style = "bold dimmed green" ``` -## Crystal +## Mercurial Branch -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 +The `hg_branch` module shows the active branch of the repo in your current directory. ### 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. | +| 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 -[crystal] -symbol = "✨ " -style = "bold blue" +[hg_branch] +symbol = "🌱 " +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