mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-11-15 23:44:03 -08:00
56 lines
2.8 KiB
Plaintext
56 lines
2.8 KiB
Plaintext
---
|
|
id: ruby
|
|
title: Ruby
|
|
sidebar_label: Ruby
|
|
---
|
|
|
|
## What
|
|
|
|
Display the currently active ruby version.
|
|
|
|
## Sample Configuration
|
|
|
|
import Config from "@site/src/components/Config.js";
|
|
|
|
<Config
|
|
data={{
|
|
type: "ruby",
|
|
style: "powerline",
|
|
powerline_symbol: "\uE0B0",
|
|
foreground: "#ffffff",
|
|
background: "#4063D8",
|
|
template: " \uE791 {{ .Full }}",
|
|
}}
|
|
/>
|
|
|
|
## Properties
|
|
|
|
| Name | Type | Description |
|
|
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
|
|
| `fetch_version` | `boolean` | display the ruby 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 `*.rb`, `Gemfile` or `Rakefile` files are present (**default**)</li></ul> |
|
|
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
|
|
| `folders` | `[]string` | allows to override the list of folder names to validate |
|
|
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
|
|
|
|
## Template ([info][templates])
|
|
|
|
:::note default template
|
|
|
|
```template
|
|
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
|
|
```
|
|
|
|
:::
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| -------- | -------- | -------------------------------------------------- |
|
|
| `.Full` | `string` | the full version |
|
|
| `.Error` | `string` | error encountered when fetching the version string |
|
|
|
|
[templates]: /docs/configuration/templates
|