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

63 lines
3.3 KiB
Plaintext
Raw Normal View History

2022-03-02 17:38:09 -08:00
---
id: swift
title: Swift
sidebar_label: Swift
---
## What
Display the currently active [Swift][swift] version.
## Sample Configuration
2024-01-13 02:11:22 -08:00
import Config from "@site/src/components/Config.js";
<Config
data={{
type: "swift",
style: "powerline",
powerline_symbol: "\uE0B0",
foreground: "#ffffff",
background: "#f6553c",
template: " \ue755 {{ .Full }} ",
}}
/>
2022-03-02 17:38:09 -08:00
## Properties
2024-01-13 02:11:22 -08:00
| Name | Type | Description |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the swift 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 `*.swift` or `*.SWIFT` 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 |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folders names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
2022-03-02 17:38:09 -08:00
## Template ([info][templates])
:::note default template
```template
2022-03-02 17:38:09 -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-02 17:38:09 -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-02 17:38:09 -08:00
[swift]: https://www.swift.org/