oh-my-posh/website/docs/segments/nbgv.mdx

52 lines
1.5 KiB
Plaintext
Raw Normal View History

2021-06-04 10:27:39 -07:00
---
id: nbgv
title: Nerdbank.GitVersioning
sidebar_label: Nbgv
---
## What
Display the [Nerdbank.GitVersioning][nbgv] version.
:::caution
2021-06-04 10:27:39 -07:00
The Nerdbank.GitVersioning CLI can be a bit slow causing the prompt to feel slow.
:::
## Sample Configuration
2023-03-31 11:55:36 -07:00
import Config from '@site/src/components/Config.js';
<Config data={{
2021-06-04 10:27:39 -07:00
"type": "nbgv",
"style": "powerline",
"powerline_symbol": "\uE0B0",
2021-06-04 10:27:39 -07:00
"foreground": "#ffffff",
"background": "#3a579a",
2022-03-27 01:12:47 -07:00
"template": " \uF1D2 {{ .Version }} "
2023-03-31 11:55:36 -07:00
}}/>
2021-06-04 10:27:39 -07:00
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
```template
2022-02-01 03:10:46 -08:00
{{ .Version }}
```
:::
### Properties
2021-06-04 10:27:39 -07:00
| Name | Type | Description |
| ------------------------------- | -------- | ------------------------------------------ |
| `.Version` | `string` | the current version |
| `.AssemblyVersion` | `string` | the current assembly version |
| `.AssemblyInformationalVersion` | `string` | the current assembly informational version |
| `.NuGetPackageVersion` | `string` | the current nuget package version |
| `.ChocolateyPackageVersion` | `string` | the current chocolatey package version |
| `.NpmPackageVersion` | `string` | the current npm package version |
| `.SimpleVersion` | `string` | the current simple version |
2021-06-04 10:27:39 -07:00
[nbgv]: https://github.com/dotnet/Nerdbank.GitVersioning
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates