mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-09-20 21:47:31 -07:00
55 lines
2.5 KiB
Plaintext
55 lines
2.5 KiB
Plaintext
|
---
|
||
|
|
id: buf
|
||
|
|
title: Buf
|
||
|
|
sidebar_label: Buf
|
||
|
|
---
|
||
|
|
|
||
|
|
## What
|
||
|
|
|
||
|
|
Display the currently active [Buf CLI][buf-docs] version.
|
||
|
|
|
||
|
|
## Sample Configuration
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"type": "buf",
|
||
|
|
"style": "plain",
|
||
|
|
"foreground": "#1000D6",
|
||
|
|
"template": " 🐃 {{ .Full }} "
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
| Name | Type | Description |
|
||
|
|
| ---------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
|
|
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
|
||
|
|
| `fetch_version` | `boolean` | fetch the active version or not; useful if all you need is an icon indicating `buf` |
|
||
|
|
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `buf.yaml`, `buf.gen.yaml` or `buf.work.yaml` files are present (**default**)</li></ul> |
|
||
|
|
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
|
||
|
|
|
||
|
|
## Template ([info][templates])
|
||
|
|
|
||
|
|
:::note default template
|
||
|
|
|
||
|
|
```template
|
||
|
|
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
|
||
|
|
```
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
### Properties
|
||
|
|
|
||
|
|
| Name | Type | Description |
|
||
|
|
| -------- | -------- | -------------------------------------------------- |
|
||
|
|
| `.Full` | `string` | the full version |
|
||
|
|
| `.Major` | `string` | major number |
|
||
|
|
| `.Minor` | `string` | minor number |
|
||
|
|
| `.Patch` | `string` | patch number |
|
||
|
|
| `.URL` | `string` | URL of the version info / release notes |
|
||
|
|
| `.Error` | `string` | error encountered when fetching the version string |
|
||
|
|
|
||
|
|
[go-text-template]: https://golang.org/pkg/text/template/
|
||
|
|
[templates]: /docs/configuration/templates
|
||
|
|
[buf-docs]: https://buf.build/
|