Skip to content

Commit

Permalink
feat(vlang): add V lang segment
Browse files Browse the repository at this point in the history
  • Loading branch information
Pietrucci-Blacher authored and JanDeDobbeleer committed Mar 3, 2025
1 parent d267951 commit d7a5b02
Show file tree
Hide file tree
Showing 6 changed files with 187 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/config/segment_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,8 @@ const (
UNITY SegmentType = "unity"
// UPGRADE lets you know if you can upgrade Oh My Posh
UPGRADE SegmentType = "upgrade"
// V writes the active vlang version
V SegmentType = "v"
// VALA writes the active vala version
VALA SegmentType = "vala"
// WAKATIME writes tracked time spend in dev editors
Expand Down Expand Up @@ -326,6 +328,7 @@ var Segments = map[SegmentType]func() SegmentWriter{
UMBRACO: func() SegmentWriter { return &segments.Umbraco{} },
UNITY: func() SegmentWriter { return &segments.Unity{} },
UPGRADE: func() SegmentWriter { return &segments.Upgrade{} },
V: func() SegmentWriter { return &segments.V{} },
VALA: func() SegmentWriter { return &segments.Vala{} },
WAKATIME: func() SegmentWriter { return &segments.Wakatime{} },
WINREG: func() SegmentWriter { return &segments.WindowsRegistry{} },
Expand Down
22 changes: 22 additions & 0 deletions src/segments/v.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package segments

type V struct {
language
}

func (v *V) Template() string {
return languageTemplate
}

func (v *V) Enabled() bool {
v.extensions = []string{"*.v"}

v.commands = []*cmd{
{
executable: "v",
args: []string{"--version"},
regex: `V (?P<version>(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)) [a-f0-9]+`,
},
}
return v.language.Enabled()
}
46 changes: 46 additions & 0 deletions src/segments/v_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package segments

import (
"fmt"
"testing"

"github.com/stretchr/testify/assert"
)

func TestV(t *testing.T) {
cases := []struct {
Case string
ExpectedString string
Version string
}{
{
Case: "V 0.4.9",
ExpectedString: "0.4.9",
Version: "V 0.4.9 b487986",
},
{
Case: "V 0.4.8",
ExpectedString: "0.4.8",
Version: "V 0.4.8 a123456",
},
{
Case: "V 0.4.7",
ExpectedString: "0.4.7",
Version: "V 0.4.7 f789012",
},
}

for _, tc := range cases {
params := &mockedLanguageParams{
cmd: "v",
versionParam: "--version",
versionOutput: tc.Version,
extension: "*.v",
}
env, props := getMockedLanguageEnv(params)
v := &V{}
v.Init(props, env)
assert.True(t, v.Enabled(), fmt.Sprintf("Failed in case: %s", tc.Case))
assert.Equal(t, tc.ExpectedString, renderTemplate(env, v.Template(), v), fmt.Sprintf("Failed in case: %s", tc.Case))
}
}
53 changes: 53 additions & 0 deletions themes/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,7 @@
"umbraco",
"unity",
"upgrade",
"v",
"vala",
"wakatime",
"winreg",
Expand Down Expand Up @@ -4148,6 +4149,58 @@
}
}
},
{
"if": {
"properties": {
"type": {
"const": "v"
}
}
},
"then": {
"title": "V Segment",
"description": "https://ohmyposh.dev/docs/segments/languages/v",
"properties": {
"properties": {
"properties": {
"home_enabled": {
"$ref": "#/definitions/home_enabled"
},
"fetch_version": {
"$ref": "#/definitions/fetch_version"
},
"cache_duration": {
"$ref": "#/definitions/cache_duration",
"default": "none"
},
"display_mode": {
"$ref": "#/definitions/display_mode"
},
"missing_command_text": {
"$ref": "#/definitions/missing_command_text"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a V project",
"default": [
"*.v"
],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
}
}
},
{
"if": {
"properties": {
Expand Down
62 changes: 62 additions & 0 deletions website/docs/segments/languages/v.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
id: v
title: V
sidebar_label: V
---

## What

Display the currently active V version.

## Sample Configuration

import Config from "@site/src/components/Config.js";

<Config
data={{
type: "vlang",
style: "powerline",
powerline_symbol: "\uE0B0",
foreground: "#193549",
background: "#4F87FF",
template: " \ue6ac {{ .Full }} ",
}}
/>

## Properties

| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the V version (`v --version`) |
| `cache_duration` | `string` | `none` | the duration for which the version will be cached. The duration is a string in the format `1h2m3s` and is parsed using the [time.ParseDuration] function from the Go standard library. To disable the cache, use `none` |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.v` | 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])

:::note default template

```template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```

:::

### Properties

| Name | Type | Description |
| ------------- | -------- | -------------------------------------------------- |
| `.Full` | `string` | the full version (e.g., "0.4.9") |
| `.Major` | `string` | major number (e.g., "0") |
| `.Minor` | `string` | minor number (e.g., "4") |
| `.Patch` | `string` | patch number (e.g., "9") |
| `.Commit` | `string` | commit hash (e.g., "b487986") |
| `.Error` | `string` | error encountered when fetching the version string |

[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ module.exports = {
"segments/languages/ruby",
"segments/languages/rust",
"segments/languages/swift",
"segments/languages/v",
"segments/languages/vala",
"segments/languages/zig",
]
Expand Down

0 comments on commit d7a5b02

Please sign in to comment.