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(nim): add Nim lang segment

Browse source 
https://nim-lang.org/
This commit is contained in:
Pietrucci-Blacher 2024-12-28 16:48:06 +01:00 committed by Jan De Dobbeleer
parent f000792340
commit bb5ec3c7f8
6 changed files with 184 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/config/segment_types.go
View file

@ -129,6 +129,8 @@ const (
NBGV SegmentType = "nbgv"
// NIGHTSCOUT is an open source diabetes system
NIGHTSCOUT SegmentType = "nightscout"
// NIM writes the active nim version
NIM SegmentType = "nim"
// NIXSHELL writes the active nix shell details
NIXSHELL SegmentType = "nix-shell"
// NODE writes which node version is currently active
@ -283,6 +285,7 @@ var Segments = map[SegmentType]func() SegmentWriter{
NBGV: func() SegmentWriter { return &segments.Nbgv{} },
NIGHTSCOUT: func() SegmentWriter { return &segments.Nightscout{} },
NIXSHELL: func() SegmentWriter { return &segments.NixShell{} },
NIM: func() SegmentWriter { return &segments.Nim{} },
NODE: func() SegmentWriter { return &segments.Node{} },
NPM: func() SegmentWriter { return &segments.Npm{} },
NX: func() SegmentWriter { return &segments.Nx{} },

22
src/segments/nim.go Normal file
View file

@ -0,0 +1,22 @@
package segments
type Nim struct {
language
}
func (n *Nim) Template() string {
return languageTemplate
}
func (n *Nim) Enabled() bool {
n.extensions = []string{"*.nim", "*.nims"}
n.commands = []*cmd{
{
executable: "nim",
args: []string{"--version"},
regex: `Nim Compiler Version (?P<version>(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+))`,
},
}
return n.language.Enabled()
}

46
src/segments/nim_test.go Normal file
View file

@ -0,0 +1,46 @@
package segments
import (
"fmt"
"testing"
"github.com/stretchr/testify/assert"
)
func TestNim(t *testing.T) {
cases := []struct {
Case string
ExpectedString string
Version string
}{
{
Case: "Nim 2.2.0",
ExpectedString: "2.2.0",
Version: "Nim Compiler Version 2.2.0 [MacOSX: arm64]\nCompiled at 2024-11-30\nCopyright (c) 2006-2024 by Andreas Rumpf",
},
{
Case: "Nim 1.6.12",
ExpectedString: "1.6.12",
Version: "Nim Compiler Version 1.6.12 [Linux: amd64]\nCompiled at 2023-06-15\nCopyright (c) 2006-2023 by Andreas Rumpf",
},
{
Case: "Nim 2.0.0",
ExpectedString: "2.0.0",
Version: "Nim Compiler Version 2.0.0 [Windows: amd64]\nCompiled at 2023-12-25\nCopyright (c) 2006-2023 by Andreas Rumpf",
},
}
for _, tc := range cases {
params := &mockedLanguageParams{
cmd: "nim",
versionParam: "--version",
versionOutput: tc.Version,
extension: "*.nim",
}
env, props := getMockedLanguageEnv(params)
n := &Nim{}
n.Init(props, env)
assert.True(t, n.Enabled(), fmt.Sprintf("Failed in case: %s", tc.Case))
assert.Equal(t, tc.ExpectedString, renderTemplate(env, n.Template(), n), fmt.Sprintf("Failed in case: %s", tc.Case))
}
}

51
themes/schema.json
View file

@ -345,6 +345,7 @@
"mvn",
"nbgv",
"nightscout",
"nim",
"nix-shell",
"node",
"npm",
@ -4722,6 +4723,56 @@
}
}
},
{
"if": {
"properties": {
"type": {
"const": "nim"
}
}
},
"then": {
"title": "Nim Segment",
"description": "https://ohmyposh.dev/docs/segments/languages/nim",
"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 a folder is a Nim workspace",
"default": [
"*.nim",
"*.nims"
]
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
}
}
},
{
"if": {
"properties": {

61
website/docs/segments/languages/nim.mdx Normal file
View file

@ -0,0 +1,61 @@
---
id: nim
title: Nim
sidebar_label: Nim
---
## What
Display the currently active Nim version.
## Sample Configuration
import Config from "@site/src/components/Config.js";
<Config
data={{
type: "nim",
style: "powerline",
powerline_symbol: "\uE0B0",
foreground: "#193549",
background: "#f3d400",
template: " \ue841 {{ .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 Nim version (`nim --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` | `*.nim, *.nims` | 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 |
| `.Major` | `string` | major number |
| `.Minor` | `string` | minor number |
| `.Patch` | `string` | patch number |
| `.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
website/sidebars.js
View file

@ -137,6 +137,7 @@ module.exports = {
"segments/languages/kotlin",
"segments/languages/lua",
"segments/languages/mojo",
"segments/languages/nim",
"segments/languages/node",
"segments/languages/ocaml",
"segments/languages/perl",