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

58 lines
2.8 KiB
Plaintext
Raw Normal View History

2022-07-15 01:17:37 -07:00
---
id: cmake
title: Cmake
sidebar_label: Cmake
---
## What
Display the currently active [Cmake][cmake-github] version.
## Sample Configuration
2023-03-31 11:55:36 -07:00
import Config from '@site/src/components/Config.js';
<Config data={{
2022-07-15 01:17:37 -07:00
"type": "cmake",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#E8EAEE",
"background": "#1E9748",
"template": " \ue61e \ue61d cmake {{ .Full }} "
2023-03-31 11:55:36 -07:00
}}/>
2022-07-15 01:17:37 -07:00
## Properties
| Name | Type | Description |
| ---------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the cmake version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.cmake` or `CMakeLists.txt` 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 |
2022-07-15 01:17:37 -07:00
## 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 |
2022-07-15 01:17:37 -07:00
[cmake-github]: https://github.com/Kitware/CMake
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates