oh-my-posh/website/docs/segments/crystal.md

56 lines
1.5 KiB
Markdown
Raw Normal View History

2021-05-14 04:39:49 -07:00
---
id: crystal
title: Crystal
sidebar_label: Crystal
---
## What
Display the currently active crystal version.
## Sample Configuration
```json
{
"type": "crystal",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#ffffff",
"background": "#4063D8",
2022-03-27 01:12:47 -07:00
"template": " \uE370 {{ .Full }} "
2021-05-14 04:39:49 -07:00
}
```
## Properties
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
2022-01-22 10:46:56 -08:00
- fetch_version: `boolean` - fetch the julia version - defaults to `true`
2021-05-14 04:39:49 -07:00
- 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 `*.cr` or `shard.yml` files are present (default)
- version_url_template: `string` - a go [text/template][go-text-template] [template][templates] that creates
the URL of the version info / release notes
2021-12-03 11:36:30 -08:00
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
``` template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```
:::
### Properties
2021-12-03 11:36:30 -08:00
- `.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
2021-12-03 11:36:30 -08:00
[go-text-template]: https://golang.org/pkg/text/template/
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates