diff options
| author | Aaron Friel <mayreply@aaronfriel.com> | 2022-01-25 08:40:44 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-25 10:40:44 -0600 |
| commit | 568d0570322ccc06f62237ea6b36d53e6a5bbf88 (patch) | |
| tree | 9338e25fbc40cdc40ea4c775078a30c78224ec4f /docs/config | |
| parent | f4ddaa0d60f739e0b7b2358e80bb7fa23afe7fc2 (diff) | |
feat: add username to Pulumi module (#3428)
* feat: add username to Pulumi module
* run dprint fmt
Diffstat (limited to 'docs/config')
| -rw-r--r-- | docs/config/README.md | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index e65a28df0..168c76c07 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2424,7 +2424,7 @@ 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. +The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. ::: tip @@ -2440,13 +2440,13 @@ By default the module will be shown if any of the following conditions are met: ### 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. | +| Option | Default | Description | +| ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($username@)$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 @@ -2454,6 +2454,7 @@ By default the module will be shown if any of the following conditions are met: | -------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `pulumi` | | stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | |