diff options
| author | Nicola Corti <corti.nico@gmail.com> | 2020-12-26 15:26:50 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-26 15:26:50 +0100 |
| commit | 208251adefcfdba3604821daca848b76e78ff0eb (patch) | |
| tree | 07a5d5a9a664b23710d72ded1b44d7e7a62f6fe0 /docs | |
| parent | 53a08712eb2de5d507655d423cc78e7130a32dd1 (diff) | |
feat(kotlin): Add the kotlin module (#2026)
Add a module to show the currently installed Kotlin version if a
.kt/.kts file is found in the current folder
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 13bd36848..c52150672 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -206,6 +206,7 @@ $golang\ $helm\ $java\ $julia\ +$kotlin\ $nim\ $nodejs\ $ocaml\ @@ -1442,6 +1443,50 @@ The module will be shown if any of the following conditions are met: symbol = "∴ " ``` +## Kotlin + +The `kotlin` module shows the currently installed version of Kotlin. +The module will be shown if any of the following conditions are met: + +- The current directory contains a `.kt` or a `.kts` file + +### Options + +| Option | Default | Description | +| --------------- | ---------------------------------- | ----------------------------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | The format for the module. | +| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | +| `style` | `"bold blue"` | The style for the module. | +| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | + +### Variables + +| Variable | Example | Description | +| -------- | --------- | ------------------------------------ | +| version | `v1.4.21` | The version of `kotlin` | +| 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 + +### Example + +```toml +# ~/.config/starship.toml + +[kotlin] +symbol = "🅺 " +``` + +```toml +# ~/.config/starship.toml + +[kotlin] +# Uses the Kotlin Compiler binary to get the installed version +kotlin_binary = "kotlinc" +``` + ## Kubernetes Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. |