diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2021-08-15 21:30:58 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-15 21:30:58 +0200 |
| commit | 9e5fcd1e140af12531f24b790a9372d5e48a8231 (patch) | |
| tree | 2fee094e538c63c23dbab2a15d9ee87ccffbe709 /docs | |
| parent | 7038ae2ec871192b6a39f7b03f4ae1e6caecb09b (diff) | |
feat(red,vlang): Add version formatting (#2987)
Have added version formatting to the red and vlang modules. Note the
docs for red already mentioned the `version_format` string but it had
not actually been added.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index cce6a4e14..b5ed73eca 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -3044,21 +3044,22 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"V "` | A format string representing the symbol of V | -| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"blue bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vlang` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"V "` | A format string representing the symbol of V | +| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | +| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"blue bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables | Variable | Example | Description | | -------- | -------- | ------------------------------------ | -| version | `v0.2` | The version of `v` | +| version | `v0.2` | The version of `v` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | |