oh-my-posh/website/docs/segments/cli/bazel.mdx

64 lines
5 KiB
Plaintext
Raw Normal View History

2023-11-09 01:31:48 -08:00
---
id: bazel
title: Bazel
sidebar_label: Bazel
---
## What
Display the currently active [Bazel][bazel-github] version.
## Sample Configuration
import Config from "@site/src/components/Config.js";
2024-01-13 02:11:22 -08:00
<Config
data={{
type: "bazel",
style: "powerline",
powerline_symbol: "\uE0B0",
foreground: "#ffffff",
background: "#43a047",
}}
/>
2023-11-09 01:31:48 -08:00
## Properties
| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the Bazel version - defaults to |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info documentation |
| `icon` | `string` | `\ue63a` | the icon for the segment |
| `extensions` | `[]string` | `*.bazel, *.bzl, BUILD, WORKSPACE, .bazelrc, .bazelversion` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
2023-11-09 01:31:48 -08:00
## Template ([info][templates])
:::note default template
```template
{{ if .Error }}{{ .Icon }} {{ .Error }}{{ else }}{{ url .Icon .URL }} {{ .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 |
| `.Icon` | `string` | the icon representing Bazel's logo |
[bazel-github]: https://github.com/bazelbuild/bazel
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates