oh-my-posh/docs/docs/segment-golang.md
2022-02-03 10:44:18 +01:00

1.5 KiB

id title sidebar_label
golang Golang Golang

What

Display the currently active golang version.

Sample Configuration

{
  "type": "go",
  "style": "powerline",
  "powerline_symbol": "\uE0B0",
  "foreground": "#ffffff",
  "background": "#7FD5EA",
  "properties": {
    "template": " \uFCD1 {{ .Full }} "
  }
}

Properties

  • home_enabled: boolean - display the segment in the HOME folder or not - defaults to false
  • fetch_version: boolean - display the golang version - defaults to true
  • display_error: boolean - show the error context when failing to retrieve the version information - defaults to true
  • missing_command_text: string - text to display when the command is missing - defaults to empty
  • display_mode: string - determines when the segment is displayed
    • always: the segment is always displayed
    • files: the segment is only displayed when *.go or go.mod files are present (default)
  • parse_mod_file: boolean: parse the go.mod file instead of calling go version

Template (info)

:::note default template

{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}

:::

Properties

  • .Full: string - the full version
  • .Major: string - major number
  • .Minor: string - minor number
  • .Patch: string - patch number
  • .Prerelease: string - prerelease info text
  • .BuildMetadata: string - build metadata
  • .Error: string - when fetching the version string errors