2020-10-22 04:47:42 -07:00
|
|
|
---
|
|
|
|
id: golang
|
|
|
|
title: Golang
|
|
|
|
sidebar_label: Golang
|
|
|
|
---
|
|
|
|
|
|
|
|
## What
|
|
|
|
|
2021-02-03 23:38:55 -08:00
|
|
|
Display the currently active golang version.
|
2020-10-22 04:47:42 -07:00
|
|
|
|
|
|
|
## Sample Configuration
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"type": "go",
|
|
|
|
"style": "powerline",
|
|
|
|
"powerline_symbol": "\uE0B0",
|
|
|
|
"foreground": "#ffffff",
|
|
|
|
"background": "#7FD5EA",
|
2022-03-27 01:12:47 -07:00
|
|
|
"template": " \uFCD1 {{ .Full }} "
|
2020-10-22 04:47:42 -07:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
2021-07-31 07:54:25 -07:00
|
|
|
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
|
2022-01-22 10:46:56 -08:00
|
|
|
- fetch_version: `boolean` - display the golang version - defaults to `true`
|
2020-12-31 22:15:19 -08:00
|
|
|
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
|
2020-12-21 11:16:33 -08:00
|
|
|
- display_mode: `string` - determines when the segment is displayed
|
2021-02-03 23:38:55 -08:00
|
|
|
- `always`: the segment is always displayed
|
|
|
|
- `files`: the segment is only displayed when `*.go` or `go.mod` files are present (default)
|
2022-05-16 08:20:03 -07:00
|
|
|
- version_url_template: `string` - a go [text/template][go-text-template] [template][templates] that creates
|
|
|
|
the URL of the version info / release notes
|
2021-12-13 13:35:42 -08:00
|
|
|
- parse_mod_file: `boolean`: parse the go.mod file instead of calling `go version`
|
2021-12-03 11:36:30 -08:00
|
|
|
|
2022-02-01 03:10:46 -08:00
|
|
|
## Template ([info][templates])
|
|
|
|
|
|
|
|
:::note default template
|
|
|
|
|
|
|
|
``` template
|
|
|
|
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
|
|
|
|
```
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
### Properties
|
2021-12-03 11:36:30 -08:00
|
|
|
|
|
|
|
- `.Full`: `string` - the full version
|
2021-12-04 01:32:50 -08:00
|
|
|
- `.Major`: `string` - major number
|
|
|
|
- `.Minor`: `string` - minor number
|
|
|
|
- `.Patch`: `string` - patch number
|
2022-05-12 03:40:17 -07:00
|
|
|
- `.URL`: `string` - URL of the version info / release notes
|
|
|
|
- `.Error`: `string` - error encountered when fetching the version string
|
2022-01-22 10:46:56 -08:00
|
|
|
|
2022-05-16 08:20:03 -07:00
|
|
|
[go-text-template]: https://golang.org/pkg/text/template/
|
2022-04-20 09:43:59 -07:00
|
|
|
[templates]: /docs/configuration/templates
|