mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2025-03-05 20:49:04 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(language): allow tweaking version cache

Browse source
This commit is contained in:
Jan De Dobbeleer 2024-11-08 12:04:41 +01:00 committed by Jan De Dobbeleer
parent 2a05bc8e37
commit 7f97c36adb
49 changed files with 363 additions and 259 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/cache/duration.go vendored
View file

@ -8,12 +8,17 @@ type Duration string
const ( const (
INFINITE = Duration("infinite") INFINITE = Duration("infinite")
NONE = Duration("none")
ONEWEEK = Duration("168h") ONEWEEK = Duration("168h")
ONEDAY = Duration("24h") ONEDAY = Duration("24h")
TWOYEARS = Duration("17520h") TWOYEARS = Duration("17520h")
) )
func (d Duration) Seconds() int { func (d Duration) Seconds() int {
if d == NONE {
return 0
}
if d == INFINITE { if d == INFINITE {
return -1 return -1
} }

8
src/cache/file.go vendored
View file

@ -77,10 +77,16 @@ func (fc *File) Get(key string) (string, bool) {
// sets the value for the given key with a duration // sets the value for the given key with a duration
func (fc *File) Set(key, value string, duration Duration) { func (fc *File) Set(key, value string, duration Duration) {
seconds := duration.Seconds()
if seconds == 0 {
return
}
fc.cache.Set(key, &Entry{ fc.cache.Set(key, &Entry{
Value: value, Value: value,
Timestamp: time.Now().Unix(), Timestamp: time.Now().Unix(),
TTL: duration.Seconds(), TTL: seconds,
}) })
fc.dirty = true fc.dirty = true

5
src/config/migrate.go
View file

@ -28,7 +28,10 @@ func (segment *Segment) migrate(version int) {
return return
} }
// Cache settings // Cache settings, the default is now 24h so we have to respect this being disabled previously
if !segment.Properties.GetBool("cache_version", false) {
segment.Properties[properties.CacheDuration] = cache.NONE
}
delete(segment.Properties, "cache_version") delete(segment.Properties, "cache_version")
segment.IncludeFolders = segment.migrateFolders(includeFolders) segment.IncludeFolders = segment.migrateFolders(includeFolders)

3
src/segments/language.go
View file

@ -239,7 +239,8 @@ func (l *language) setVersion() error {
l.version.Executable = command.executable l.version.Executable = command.executable
if marchalled, err := json.Marshal(l.version); err == nil { if marchalled, err := json.Marshal(l.version); err == nil {
l.env.Cache().Set(cacheKey, string(marchalled), cache.ONEWEEK) duration := l.props.GetString(properties.CacheDuration, string(cache.ONEWEEK))
l.env.Cache().Set(cacheKey, string(marchalled), cache.Duration(duration))
} }
return nil return nil

2
themes/schema.json
View file

@ -145,7 +145,7 @@
"type": "string", "type": "string",
"title": "Cache duration", "title": "Cache duration",
"description": "The duration for which the segment will be cached. This is parsed using the `time.ParseDuration` function from the Go standard library (see https://pkg.go.dev/time#ParseDuration for details).", "description": "The duration for which the segment will be cached. This is parsed using the `time.ParseDuration` function from the Go standard library (see https://pkg.go.dev/time#ParseDuration for details).",
"pattern": "^(infinite|([0-9]+(h|m|s))+)$" "pattern": "^(none|infinite|([0-9]+(h|m|s))+)$"
}, },
"filler": { "filler": {
"type": "string", "type": "string",

10
website/docs/configuration/segment.mdx
View file

@ -116,10 +116,10 @@ The cache property allows you to control how often a segment is refreshed. This
generate or when you want to avoid fetching information too often. The cache property is an object with the following generate or when you want to avoid fetching information too often. The cache property is an object with the following
properties: properties:
| Name | Type | Description | | Name | Type | Description |
| ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `duration` | `string` | the duration for which the segment will be cached. The duration is a string in the format `1h2m3s`. The duration is parsed using the [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) function from the Go standard library | | `duration` | `string` | the duration for which the segment will be cached. The duration is a string in the format `1h2m3s`. The duration is parsed using the [time.ParseDuration] function from the Go standard library. To disable the cache, use `none` |
| `strategy` | `string` | the strategy to use to identify if we should show the segment's cache value. See below for more information on strategy | | `strategy` | `string` | the strategy to use to identify if we should show the segment's cache value. See below for more information on strategy |
<Config <Config
data={{ data={{
@ -182,6 +182,7 @@ You can also combine these properties:
/> />
:::info :::info
- Oh My Posh will accept both `/` and `\` as path separators for a folder and will match regardless of which - Oh My Posh will accept both `/` and `\` as path separators for a folder and will match regardless of which
is used by the current operating system. is used by the current operating system.
- Because the strings are evaluated as regular expressions, if you want to use a backslash (`\`) in a Windows - Because the strings are evaluated as regular expressions, if you want to use a backslash (`\`) in a Windows
@ -236,3 +237,4 @@ To list the currently toggled segments, use `oh-my-posh get toggles`.
[cstp]: templates.mdx#cross-segment-template-properties [cstp]: templates.mdx#cross-segment-template-properties
[cache]: #cache [cache]: #cache
[include-exclude]: #include--exclude-folders [include-exclude]: #include--exclude-folders
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/angular.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the angular version | | `fetch_version` | `boolean` | `true` | fetch the angular version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `angular.json` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `angular.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[angular-cli-docs]: https://angular.io/cli [angular-cli-docs]: https://angular.io/cli
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/aurelia.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the aurelia version | | `fetch_version` | `boolean` | `true` | fetch the aurelia version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `package.json` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `package.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[aurelia]: https://docs.aurelia.io/ [aurelia]: https://docs.aurelia.io/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

16
website/docs/segments/cli/bazel.mdx
View file

@ -24,14 +24,15 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :---------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the Bazel version - defaults to | | `fetch_version` | `boolean` | `true` | display the Bazel version - defaults to |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info documentation | | `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> |
| `icon` | `string` | `\ue63a` | the icon for the segment | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info documentation |
| `icon` | `string` | `\ue63a` | the icon for the segment |
| `extensions` | `[]string` | `*.bazel, *.bzl, BUILD, WORKSPACE, .bazelrc, .bazelversion` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.bazel, *.bzl, BUILD, WORKSPACE, .bazelrc, .bazelversion` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | | | `folders` | `[]string` | | |
@ -60,3 +61,4 @@ import Config from "@site/src/components/Config.js";
[bazel-github]: https://github.com/bazelbuild/bazel [bazel-github]: https://github.com/bazelbuild/bazel
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/buf.mdx
View file

@ -23,13 +23,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `buf` | | `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `buf` |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `buf.yaml, buf.gen.yaml, buf.work.yaml` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `buf.yaml, buf.gen.yaml, buf.work.yaml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -57,3 +58,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[buf-docs]: https://buf.build/ [buf-docs]: https://buf.build/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

20
website/docs/segments/cli/bun.mdx
View file

@ -23,15 +23,16 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :---------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `bun` | | `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `bun` |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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> |
| `extensions` | `[]string` | `bun.lockb` | allows to override the default list of file extensions to validate | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `extensions` | `[]string` | `bun.lockb` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
## Template ([info][templates]) ## Template ([info][templates])
@ -57,3 +58,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[bun-docs]: https://bun.sh/ [bun-docs]: https://bun.sh/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/cmake.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the cmake version | | `fetch_version` | `boolean` | `true` | display the cmake version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.cmake, CMakeLists.txt` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.cmake, CMakeLists.txt` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[cmake-github]: https://github.com/Kitware/CMake [cmake-github]: https://github.com/Kitware/CMake
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/deno.mdx
View file

@ -23,13 +23,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :---------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `deno` | | `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `deno` |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.ts, *.js, deno.json` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.ts, *.js, deno.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -57,3 +58,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[deno-docs]: https://deno.land/ [deno-docs]: https://deno.land/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

16
website/docs/segments/cli/flutter.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the flutter version | | `fetch_version` | `boolean` | `true` | fetch the flutter version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.dart, pubspec.yaml, pubspec.yml, pubspec.lock` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.dart, pubspec.yaml, pubspec.yml, pubspec.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | `.dart_tool` | allows to override the list of folder names to validate | | `folders` | `[]string` | `.dart_tool` | allows to override the list of folder names to validate |
## Template ([info][templates]) ## Template ([info][templates])
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[flutter]: https://flutter.dev/ [flutter]: https://flutter.dev/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

6
website/docs/segments/cli/mvn.mdx
View file

@ -26,9 +26,10 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
|------------------------|:----------:|:---------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ---------------------- | :--------: | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the Maven version | | `fetch_version` | `boolean` | `true` | fetch the Maven version |
| `cache_duration` | `string` | `24h` | 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 | | `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> | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
@ -48,7 +49,7 @@ import Config from "@site/src/components/Config.js";
### Properties ### Properties
| Name | Type | Description | | Name | Type | Description |
|----------|----------|----------------------------------------------------| | -------- | -------- | -------------------------------------------------- |
| `.Full` | `string` | the full version | | `.Full` | `string` | the full version |
| `.Major` | `string` | major number | | `.Major` | `string` | major number |
| `.Minor` | `string` | minor number | | `.Minor` | `string` | minor number |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[maven-docs]: https://maven.apache.org [maven-docs]: https://maven.apache.org
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/npm.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the NPM version | | `fetch_version` | `boolean` | `true` | fetch the NPM version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `package.json, package-lock.json` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `package.json, package-lock.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[npm-docs]: https://docs.npmjs.com/about-npm [npm-docs]: https://docs.npmjs.com/about-npm
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/nx.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not | | `fetch_version` | `boolean` | `true` | fetch the active version or not |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `workspace.json, nx.json` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `workspace.json, nx.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[nx-docs]: https://nx.dev [nx-docs]: https://nx.dev
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

2
website/docs/segments/cli/pnpm.mdx
View file

@ -29,6 +29,7 @@ import Config from "@site/src/components/Config.js";
| ---------------------- | :--------: | :----------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :----------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the PNPM version | | `fetch_version` | `boolean` | `true` | fetch the PNPM version |
| `cache_duration` | `string` | `24h` | 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 | | `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> | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[pnpm-docs]: https://pnpm.io [pnpm-docs]: https://pnpm.io
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

16
website/docs/segments/cli/quasar.mdx
View file

@ -26,14 +26,15 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `missing_command_text` | `string` | | text to display when the command is missing | | `missing_command_text` | `string` | | text to display when the command is missing |
| `fetch_version` | `boolean` | `true` | fetch the NPM version | | `fetch_version` | `boolean` | `true` | fetch the NPM version |
| `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> | | `cache_duration` | `string` | `24h` | 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` |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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> |
| `fetch_dependencies` | `boolean` | `false` | fetch the version number of the `vite` and `@quasar/app-vite` dependencies if present | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `fetch_dependencies` | `boolean` | `false` | fetch the version number of the `vite` and `@quasar/app-vite` dependencies if present |
| `extensions` | `[]string` | `quasar.config, quasar.config.js` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `quasar.config, quasar.config.js` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -70,3 +71,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[quasar-cli]: https://quasar.dev/start/quasar-cli [quasar-cli]: https://quasar.dev/start/quasar-cli
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/react.mdx
View file

@ -24,13 +24,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the react version | | `fetch_version` | `boolean` | `true` | fetch the react version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `package.json` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `package.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[react]: https://react.dev/ [react]: https://react.dev/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/ui5tooling.mdx
View file

@ -26,13 +26,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :----------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :----------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the ui5tooling version | | `fetch_version` | `boolean` | `true` | fetch the ui5tooling version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*ui5*.y*ml` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*ui5*.y*ml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -61,3 +62,4 @@ import Config from "@site/src/components/Config.js";
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[ui5-homepage]: https://sap.github.io/ui5-tooling [ui5-homepage]: https://sap.github.io/ui5-tooling
[ui5-version-help]: https://sap.github.io/ui5-tooling/pages/CLI/#ui5-versions [ui5-version-help]: https://sap.github.io/ui5-tooling/pages/CLI/#ui5-versions
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cli/xmake.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :---------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :---------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the xmake version | | `fetch_version` | `boolean` | `true` | fetch the xmake version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `xmake.lua` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `xmake.lua` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: configuration/templates.mdx [templates]: configuration/templates.mdx
[xmake]: https://xmake.io/ [xmake]: https://xmake.io/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

2
website/docs/segments/cli/yarn.mdx
View file

@ -29,6 +29,7 @@ import Config from "@site/src/components/Config.js";
| ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the Yarn version | | `fetch_version` | `boolean` | `true` | fetch the Yarn version |
| `cache_duration` | `string` | `24h` | 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 | | `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> | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[yarn-docs]: https://yarnpkg.com [yarn-docs]: https://yarnpkg.com
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cloud/azfunc.mdx
View file

@ -29,13 +29,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :---------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the Azure Functions CLI version | | `fetch_version` | `boolean` | `true` | fetch the Azure Functions CLI version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `host.json, local.settings.json, function.json` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `host.json, local.settings.json, function.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -62,3 +63,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: configuration/templates.mdx [templates]: configuration/templates.mdx
[az-func-core-tools]: https://github.com/Azure/azure-functions-core-tools [az-func-core-tools]: https://github.com/Azure/azure-functions-core-tools
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cloud/cds.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :---------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the CDS version | | `fetch_version` | `boolean` | `true` | fetch the CDS version |
| `missing_command_text` | `string` | `""` | text to display when the cds command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | `""` | text to display when the cds command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `.cdsrc.json, .cdsrc-private.json, *.cds` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `.cdsrc.json, .cdsrc-private.json, *.cds` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: configuration/templates.mdx [templates]: configuration/templates.mdx
[sap-cap-cds]: https://cap.cloud.sap/docs/tools/#command-line-interface-cli [sap-cap-cds]: https://cap.cloud.sap/docs/tools/#command-line-interface-cli
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/cloud/cf.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the Cloud Foundry CLI version | | `fetch_version` | `boolean` | `true` | display the Cloud Foundry CLI version |
| `missing_command_text` | `string` | | text to display when the java command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the java command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `manifest.yml, mta.yaml` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `manifest.yml, mta.yaml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[cloud-foundry]: https://github.com/cloudfoundry/cli [cloud-foundry]: https://github.com/cloudfoundry/cli
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/crystal.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :---------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the crystal version | | `fetch_version` | `boolean` | `true` | fetch the crystal version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.cr, shard.yml` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.cr, shard.yml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[crystal]: https://crystal-lang.org/ [crystal]: https://crystal-lang.org/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

16
website/docs/segments/languages/dart.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the dart version | | `fetch_version` | `boolean` | `true` | fetch the dart version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.dart, pubspec.yaml, pubspec.yml, pubspec.lock` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.dart, pubspec.yaml, pubspec.yml, pubspec.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | `.dart_tool` | allows to override the list of folder names to validate | | `folders` | `[]string` | `.dart_tool` | allows to override the list of folder names to validate |
## Template ([info][templates]) ## Template ([info][templates])
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

34
website/docs/segments/languages/dotnet.mdx
View file

@ -10,26 +10,29 @@ Display the currently active [.NET SDK][net-sdk-docs] version.
## Sample Configuration ## Sample Configuration
import Config from '@site/src/components/Config.js'; import Config from "@site/src/components/Config.js";
<Config data={{ <Config
"type": "dotnet", data={{
"style": "powerline", type: "dotnet",
"powerline_symbol": "\uE0B0", style: "powerline",
"foreground": "#000000", powerline_symbol: "\uE0B0",
"background": "#00ffff", foreground: "#000000",
"template": " \uE77F {{ .Full }} " background: "#00ffff",
}}/> template: " \uE77F {{ .Full }} ",
}}
/>
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `dotnet` | | `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `dotnet` |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.cs, *.csx, *.vb, *.fs, *.fsx, *.sln, *.slnf, *.csproj, *.fsproj, *.vbproj, global.json` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.cs, *.csx, *.vb, *.fs, *.fsx, *.sln, *.slnf, *.csproj, *.fsproj, *.vbproj, global.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +62,4 @@ import Config from '@site/src/components/Config.js';
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[net-sdk-docs]: https://docs.microsoft.com/en-us/dotnet/core/tools [net-sdk-docs]: https://docs.microsoft.com/en-us/dotnet/core/tools
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/elixir.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the elixir version | | `fetch_version` | `boolean` | `true` | fetch the elixir version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.ex, *.exs` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.ex, *.exs` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[elixir]: https://elixir-lang.org/ [elixir]: https://elixir-lang.org/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

16
website/docs/segments/languages/golang.mdx
View file

@ -25,14 +25,15 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the golang version | | `fetch_version` | `boolean` | `true` | fetch the golang version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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> |
| `parse_mod_file` | `boolean` | `false` | parse the go.mod file instead of calling `go version` | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `parse_mod_file` | `boolean` | `false` | parse the go.mod file instead of calling `go version` |
| `extensions` | `[]string` | `*.go, go.mod` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.go, go.mod` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

16
website/docs/segments/languages/haskell.mdx
View file

@ -25,14 +25,15 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | :--------: | :-------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the GHC version | | `fetch_version` | `boolean` | `true` | fetch the GHC version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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> |
| `stack_ghc_mode` | `string` | `never` | determines when to use `stack ghc` to retrieve the version information. Using `stack ghc` will decrease performance.<ul><li>`never`: never use `stack ghc`</li><li>`package`: only use `stack ghc` when `stack.yaml` is in the root of the </li><li>`always`: always use `stack ghc`</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 |
| `stack_ghc_mode` | `string` | `never` | determines when to use `stack ghc` to retrieve the version information. Using `stack ghc` will decrease performance.<ul><li>`never`: never use `stack ghc`</li><li>`package`: only use `stack ghc` when `stack.yaml` is in the root of the </li><li>`always`: always use `stack ghc`</li></ul> |
| `extensions` | `[]string` | `*.hs, *.lhs, stack.yaml, package.yaml, *.cabal, cabal.project` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.hs, *.lhs, stack.yaml, package.yaml, *.cabal, cabal.project` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -60,3 +61,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/java.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :----------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the java version | | `fetch_version` | `boolean` | `true` | fetch the java version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.java, *.class, *.gradle, *.jar, *.clj, *.cljr, pom.xml, build.gradle.kts, build.sbt, .java-version, .deps.edn, project.clj, build.boot` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.java, *.class, *.gradle, *.jar, *.clj, *.cljr, pom.xml, build.gradle.kts, build.sbt, .java-version, .deps.edn, project.clj, build.boot` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -57,3 +58,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: configuration/templates.mdx [templates]: configuration/templates.mdx
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

16
website/docs/segments/languages/julia.mdx
View file

@ -25,14 +25,15 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the julia version | | `fetch_version` | `boolean` | `true` | fetch the julia version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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> |
| `extensions` | `[]string` | `*.jl` | allows to override the default list of file extensions to validate | | `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` | `*.jl` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
## Template ([info][templates]) ## Template ([info][templates])
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/kotlin.mdx
View file

@ -27,13 +27,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the kotlin version | | `fetch_version` | `boolean` | `true` | fetch the kotlin version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.kt, *.kts, *.ktm` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.kt, *.kts, *.ktm` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -61,3 +62,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[kotlin]: https://kotlinlang.org/ [kotlin]: https://kotlinlang.org/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

16
website/docs/segments/languages/lua.mdx
View file

@ -25,14 +25,15 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the lua version | | `fetch_version` | `boolean` | `true` | fetch the lua version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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> |
| `preferred_executable` | `string` | `lua` | the preferred executable to use when fetching the version<ul><li>`lua`: the Lua executable (**default**)</li><li>`luajit`: the LuaJIT executable</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 |
| `preferred_executable` | `string` | `lua` | the preferred executable to use when fetching the version<ul><li>`lua`: the Lua executable (**default**)</li><li>`luajit`: the LuaJIT executable</li></ul> |
| `extensions` | `[]string` | `*.lua, *.rockspec` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.lua, *.rockspec` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -62,3 +63,4 @@ import Config from "@site/src/components/Config.js";
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[lua]: https://www.lua.org/ [lua]: https://www.lua.org/
[luajit]: https://luajit.org/ [luajit]: https://luajit.org/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

24
website/docs/segments/languages/mojo.mdx
View file

@ -25,17 +25,18 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_virtual_env` | `boolean` | `true` | fetch the name of the virtualenv or not | | `fetch_virtual_env` | `boolean` | `true` | fetch the name of the virtualenv or not |
| `display_default` | `boolean` | `true` | show the name of the virtualenv when it's equal to `default` or not | | `display_default` | `boolean` | `true` | show the name of the virtualenv when it's equal to `default` or not |
| `fetch_version` | `boolean` | `true` | fetch the Mojo version or not | | `fetch_version` | `boolean` | `true` | fetch the Mojo version or not |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `display_mode` | `string` | `environment` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`environment`: the segment is only displayed when in a virtual environment</li><li>`context`: displays the segment when the environment or files is active</li></ul> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `display_mode` | `string` | `environment` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`environment`: the segment is only displayed when in a virtual environment</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `extensions` | `[]string` | `*.🔥, *.mojo, mojoproject.toml` | allows to override the default list of file extensions to validate | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `extensions` | `[]string` | `*.🔥, *.mojo, mojoproject.toml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
## Template ([info][templates]) ## Template ([info][templates])
@ -62,3 +63,4 @@ import Config from "@site/src/components/Config.js";
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[mojo]: https://docs.modular.com/mojo [mojo]: https://docs.modular.com/mojo
[magic]: https://docs.modular.com/magic [magic]: https://docs.modular.com/magic
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

22
website/docs/segments/languages/node.mdx
View file

@ -25,17 +25,18 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----------------------- | :--------: | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ----------------------- | :--------: | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the Node.js version | | `fetch_version` | `boolean` | `true` | fetch the Node.js version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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> |
| `fetch_package_manager` | `boolean` | `false` | define if the current project uses PNPM, Yarn, or NPM | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `pnpm_icon` | `string` | `\uF02C1` | the icon/text to display when using PNPM | | `fetch_package_manager` | `boolean` | `false` | define if the current project uses PNPM, Yarn, or NPM |
| `yarn_icon` | `string` | `\uF011B` | the icon/text to display when using Yarn | | `pnpm_icon` | `string` | `\uF02C1` | the icon/text to display when using PNPM |
| `npm_icon` | `string` | `\uE71E` | the icon/text to display when using NPM | | `yarn_icon` | `string` | `\uF011B` | the icon/text to display when using Yarn |
| `npm_icon` | `string` | `\uE71E` | the icon/text to display when using NPM |
| `extensions` | `[]string` | `*.js, *.ts, package.json, .nvmrc, pnpm-workspace.yaml, .pnpmfile.cjs, .vue` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.js, *.ts, package.json, .nvmrc, pnpm-workspace.yaml, .pnpmfile.cjs, .vue` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -66,3 +67,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[node-js]: https://nodejs.org [node-js]: https://nodejs.org
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/ocaml.mdx
View file

@ -24,13 +24,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the ocaml version (`ocaml -version`) | | `fetch_version` | `boolean` | `true` | display the ocaml version (`ocaml -version`) |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] 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 | | `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 | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[OCaml]: https://ocaml.org/ [OCaml]: https://ocaml.org/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/perl.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the perl version | | `fetch_version` | `boolean` | `true` | fetch the perl version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.pl, *.pm, *.t, .perl-version` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.pl, *.pm, *.t, .perl-version` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -56,3 +57,4 @@ import Config from "@site/src/components/Config.js";
| `.Error` | `string` | error encountered when fetching the version string | | `.Error` | `string` | error encountered when fetching the version string |
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/php.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the php version | | `fetch_version` | `boolean` | `true` | fetch the php version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.php, .php-version, composer.json, composer.lock` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.php, .php-version, composer.json, composer.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

2
website/docs/segments/languages/python.mdx
View file

@ -32,6 +32,7 @@ import Config from "@site/src/components/Config.js";
| `fetch_virtual_env` | `boolean` | `true` | fetch the name of the virtualenv or not | | `fetch_virtual_env` | `boolean` | `true` | fetch the name of the virtualenv or not |
| `display_default` | `boolean` | `true` | show the name of the virtualenv when it's default (`system`, `base`) or not | | `display_default` | `boolean` | `true` | show the name of the virtualenv when it's default (`system`, `base`) or not |
| `fetch_version` | `boolean` | `true` | fetch the python version | | `fetch_version` | `boolean` | `true` | fetch the python version |
| `cache_duration` | `string` | `24h` | 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 | | `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `environment` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`environment`: the segment is only displayed when in a virtual environment</li><li>`context`: displays the segment when the environment or files is active</li></ul> | | `display_mode` | `string` | `environment` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`environment`: the segment is only displayed when in a virtual environment</li><li>`context`: displays the segment when the environment or files is active</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 | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
@ -64,3 +65,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/r.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the R version or not | | `fetch_version` | `boolean` | `true` | fetch the R version or not |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.R, *.Rmd, *.Rsx, *.Rda, *.Rd, *.Rproj, .Rproj.user` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.R, *.Rmd, *.Rsx, *.Rda, *.Rd, *.Rproj, .Rproj.user` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[r-homepage]: https://www.r-project.org/ [r-homepage]: https://www.r-project.org/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/ruby.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the ruby version | | `fetch_version` | `boolean` | `true` | fetch the ruby version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.rb, Rakefile, Gemfile` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.rb, Rakefile, Gemfile` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -54,3 +55,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/rust.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :----------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the rust version (`rustc --version`) | | `fetch_version` | `boolean` | `true` | fetch the rust version (`rustc --version`) |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.rs, Cargo.toml, Cargo.lock` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.rs, Cargo.toml, Cargo.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

2
website/docs/segments/languages/swift.mdx
View file

@ -29,6 +29,7 @@ import Config from "@site/src/components/Config.js";
| ---------------------- | :--------: | :-------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the swift version | | `fetch_version` | `boolean` | `true` | fetch the swift version |
| `cache_duration` | `string` | `24h` | 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 | | `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> | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
@ -59,3 +60,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[swift]: https://www.swift.org/ [swift]: https://www.swift.org/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

14
website/docs/segments/languages/vala.mdx
View file

@ -25,13 +25,14 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------------- | :--------: | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the vala version | | `fetch_version` | `boolean` | `true` | fetch the vala version |
| `missing_command_text` | `string` | | text to display when the command is missing | | `cache_duration` | `string` | `24h` | 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` |
| `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> | | `missing_command_text` | `string` | | text to display when the command is missing |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.vala` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | `*.vala` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate | | `folders` | `[]string` | | allows to override the list of folder names to validate |
@ -58,3 +59,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[vala]: https://vala.dev/ [vala]: https://vala.dev/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

5
website/docs/segments/languages/zig.mdx
View file

@ -19,7 +19,8 @@ import Config from "@site/src/components/Config.js";
powerline_symbol: "\ue0b0", powerline_symbol: "\ue0b0",
foreground: "#342311", foreground: "#342311",
background: "#ffad55", background: "#ffad55",
template: " \ue6a9 {{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }} ", template:
" \ue6a9 {{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }} ",
}} }}
/> />
@ -29,6 +30,7 @@ import Config from "@site/src/components/Config.js";
| ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not | | `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the zig version (`zig version`) | | `fetch_version` | `boolean` | `true` | fetch the zig version (`zig version`) |
| `cache_duration` | `string` | `24h` | 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 | | `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> | | `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][go-text-template] [template][templates] that creates the URL of the version info / release notes | | `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
@ -62,3 +64,4 @@ import Config from "@site/src/components/Config.js";
[go-text-template]: https://golang.org/pkg/text/template/ [go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates [templates]: /docs/configuration/templates
[zig]: https://ziglang.org/ [zig]: https://ziglang.org/
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration

6
website/docs/segments/system/upgrade.mdx
View file

@ -26,9 +26,9 @@ import Config from "@site/src/components/Config.js";
## Properties ## Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ---------------- | :------: | :-----: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------- | :------: | :-----: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cache_duration` | `string` | `168h` | the duration for which the segment 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 | | `cache_duration` | `string` | `168h` | the duration for which the segment 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` |
## Template ([info][templates]) ## Template ([info][templates])