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

58 lines
2.7 KiB
Plaintext
Raw Normal View History

2022-03-01 01:01:58 -08:00
---
id: kotlin
title: Kotlin
sidebar_label: Kotlin
---
## What
Display the currently active [Kotlin][kotlin] version.
## Sample Configuration
```json
{
"type": "kotlin",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#ffffff",
"background": "#906cff",
2022-03-27 01:12:47 -07:00
"template": " \ufa05 {{ .Full }} "
2022-03-01 01:01:58 -08: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 kotlin 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 `*.kt`, `*.kts` or `*.ktm` 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-03-01 01:01:58 -08:00
## Template ([info][templates])
:::note default template
```template
2022-03-01 01:01:58 -08:00
{{ 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-03-01 01:01:58 -08:00
[go-text-template]: https://golang.org/pkg/text/template/
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates
2022-03-01 01:01:58 -08:00
[kotlin]: https://kotlinlang.org/