website/docs/segments/languages/ocaml.mdx
Display the currently active OCaml version.
import Config from "@site/src/components/Config.js";
<Config data={{ type: "ocaml", style: "powerline", powerline_symbol: "\uE0B0", foreground: "#d08770", template: " \ue67a {{ .Full }} ", }} />
| Name | Type | Default | Description |
|---|---|---|---|
home_enabled | boolean | false | display the segment in the HOME folder or not |
fetch_version | boolean | true | display the ocaml version (ocaml -version) |
cache_duration | string | none | the duration for which the version will be cached. The duration is a string in the format 1h2m3s and is parsed using the time.ParseDuration function from the Go standard library. To disable the cache, use none |
missing_command_text | string | text to display when the command is missing | |
display_mode | string | context | <ul><li>always: the segment is always displayed</li><li>files: the segment is only displayed when file extensions listed are present</li><li>context: displays the segment when the environment or files is active</li></ul> |
version_url_template | string | a go text/template template that creates the URL of the version info / release notes | |
extensions | []string | *.ml, *.mli, dune, dune-project, dune-workspace | allows to override the default list of file extensions to validate |
folders | []string | allows to override the list of folder names to validate | |
tooling | []string | ocaml | the tooling to use for fetching the version |
:::note default template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
:::
| Name | Type | Description |
|---|---|---|
.Full | string | the full version |
.Major | string | major number |
.Minor | string | minor number |
.Patch | string | patch number |
.Prerelease | string | channel name |
.Error | string | error encountered when fetching the version string |