diff options
author | Ian Wahbe <ian@wahbe.com> | 2021-10-05 16:27:25 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-05 18:27:25 -0500 |
commit | dfb1208787dc5e026b7715d5253b0294078ca82a (patch) | |
tree | cd2b43aa25da580697ca609ac69448a7d8641cd8 /docs | |
parent | 190743e4e0cab479cb10e183d86b1ed3bc5884b8 (diff) |
feat: Add pulumi module (#3055)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/config/README.md | 59 | ||||
-rw-r--r-- | docs/presets/README.md | 9 |
2 files changed, 68 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 68ffac0b8..669a08fcb 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -221,6 +221,7 @@ $nodejs\ $ocaml\ $perl\ $php\ +$pulumi\ $purescript\ $python\ $rlang\ @@ -2349,6 +2350,64 @@ By default the module will be shown if any of the following conditions are met: format = "via [🔹 $version](147 bold) " ``` +## Pulumi + +The `pulumi` module shows the currently selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/) and version. + +::: tip + +By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). +If you still want to enable it, [follow the example shown below](#with-pulumi-version). + +::: + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains either `Pulumi.yaml` or `Pulumi.yml` +- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$stack]($style) "` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string shown before the Pulumi stack. | +| `style` | `"bold 5"` | The style for the module. | +| `disabled` | `false` | Disables the `pulumi` module. | + +### Variables + +| Variable | Example | Description | +| -------- | ---------- | ------------------------------------ | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| 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 + +#### With Pulumi Version + +```toml +# ~/.config/starship.toml + +[pulumi] +format = "[🛥 ($version )$stack]($style) " +``` + +#### Without Pulumi version + +```toml +# ~/.config/starship.toml +[pulumi] +symbol = "🛥 " +format = "[$symbol$stack]($style) " + +``` + ## PureScript The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. diff --git a/docs/presets/README.md b/docs/presets/README.md index 66e7ebe25..9ea120a54 100644 --- a/docs/presets/README.md +++ b/docs/presets/README.md @@ -205,6 +205,9 @@ format = '\[[$symbol($version)]($style)\]' [php] format = '\[[$symbol($version)]($style)\]' +[pulumi] +format = '\[[$symbol$stack]($style)\]' + [purescript] format = '\[[$symbol($version)]($style)\]' @@ -354,6 +357,9 @@ symbol = "pl " [php] symbol = "php " +[pulumi] +symbol = "pulumi " + [purescript] symbol = "purs " @@ -439,6 +445,9 @@ format = 'via [$symbol]($style)' [php] format = 'via [$symbol]($style)' +[pulumi] +format = 'via [$symbol$stack]($style)' + [purescript] format = 'via [$symbol]($style)' |