2022-02-13 23:41:33 -08:00
|
|
|
---
|
|
|
|
id: ui5tooling
|
|
|
|
title: UI5 Tooling
|
|
|
|
sidebar_label: UI5 Tooling
|
|
|
|
---
|
|
|
|
|
|
|
|
## What
|
|
|
|
|
|
|
|
Display the active [UI5 tooling][ui5-homepage] version (global or local if present -
|
|
|
|
see [the documentation][ui5-version-help]).
|
|
|
|
|
|
|
|
## Sample Configuration
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"background": "#f5a834",
|
|
|
|
"foreground": "#100e23",
|
|
|
|
"powerline_symbol": "\ue0b0",
|
2022-03-27 01:12:47 -07:00
|
|
|
"template": " \ufab6ui5 {{ .Full }} ",
|
2022-02-13 23:41:33 -08:00
|
|
|
"style": "powerline",
|
|
|
|
"type": "ui5tooling"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
|
|
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
|
|
|
|
- fetch_version: `boolean` - display the UI5 tooling version - defaults to `true`
|
|
|
|
- missing_command_text: `string` - text to display when the java 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 `*ui5*.y(a)ml` file is present in the current folder
|
|
|
|
- `context`: (default) the segment is only displayed when `*ui5*.y(a)ml` file is present in the current folder
|
|
|
|
or it has been found in the parent folders (check up to 4 levels)
|
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
|
2022-02-13 23:41:33 -08:00
|
|
|
|
|
|
|
## Template ([info][templates])
|
|
|
|
|
|
|
|
:::note default template
|
|
|
|
|
|
|
|
```template
|
|
|
|
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
|
|
|
|
```
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
2022-05-16 08:20:03 -07:00
|
|
|
### Properties
|
2022-02-13 23:41:33 -08:00
|
|
|
|
|
|
|
- `.Full`: `string` - the full version
|
|
|
|
- `.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-02-13 23:41:33 -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
|
2022-02-13 23:41:33 -08:00
|
|
|
[ui5-homepage]: https://sap.github.io/ui5-tooling
|
|
|
|
[ui5-version-help]: https://sap.github.io/ui5-tooling/pages/CLI/#ui5-versions
|