mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-11-09 20:44:03 -08:00
feat(node): add Yarn segment and fix PNPM docs
This commit is contained in:
Michael Schwobe
Jan De Dobbeleer
parent
e25d271d32
commit
9b62e69348
|
|
@ -270,6 +270,8 @@ const (
|
|||
WITHINGS SegmentType = "withings"
|
||||
// XMAKE write the xmake version if xmake.lua is present
|
||||
XMAKE SegmentType = "xmake"
|
||||
// yarn version
|
||||
YARN SegmentType = "yarn"
|
||||
// YTM writes YouTube Music information and status
|
||||
YTM SegmentType = "ytm"
|
||||
)
|
||||
|
|
@ -366,6 +368,7 @@ var Segments = map[SegmentType]func() SegmentWriter{
|
|||
WINREG: func() SegmentWriter { return &segments.WindowsRegistry{} },
|
||||
WITHINGS: func() SegmentWriter { return &segments.Withings{} },
|
||||
XMAKE: func() SegmentWriter { return &segments.XMake{} },
|
||||
YARN: func() SegmentWriter { return &segments.Yarn{} },
|
||||
YTM: func() SegmentWriter { return &segments.Ytm{} },
|
||||
}
|
||||
|
||||
|
|
|
|||
34
src/segments/yarn.go
Normal file
34
src/segments/yarn.go
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
package segments
|
||||
|
||||
import (
|
||||
"github.com/jandedobbeleer/oh-my-posh/src/platform"
|
||||
"github.com/jandedobbeleer/oh-my-posh/src/properties"
|
||||
)
|
||||
|
||||
type Yarn struct {
|
||||
language
|
||||
}
|
||||
|
||||
func (n *Yarn) Enabled() bool {
|
||||
return n.language.Enabled()
|
||||
}
|
||||
|
||||
func (n *Yarn) Template() string {
|
||||
return " \U000F011B {{.Full}} "
|
||||
}
|
||||
|
||||
func (n *Yarn) Init(props properties.Properties, env platform.Environment) {
|
||||
n.language = language{
|
||||
env: env,
|
||||
props: props,
|
||||
extensions: []string{"package.json", "yarn.lock"},
|
||||
commands: []*cmd{
|
||||
{
|
||||
executable: "yarn",
|
||||
args: []string{"--version"},
|
||||
regex: `(?P<version>((?P<major>[0-9]+).(?P<minor>[0-9]+).(?P<patch>[0-9]+)))`,
|
||||
},
|
||||
},
|
||||
versionURLTemplate: "https://github.com/yarnpkg/berry/releases/tag/v{{ .Full }}",
|
||||
}
|
||||
}
|
||||
31
src/segments/yarn_test.go
Normal file
31
src/segments/yarn_test.go
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
package segments
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/alecthomas/assert"
|
||||
)
|
||||
|
||||
func TestYarn(t *testing.T) {
|
||||
cases := []struct {
|
||||
Case string
|
||||
ExpectedString string
|
||||
Version string
|
||||
}{
|
||||
{Case: "1.0.0", ExpectedString: "\U000F011B 1.0.0", Version: "1.0.0"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
params := &mockedLanguageParams{
|
||||
cmd: "yarn",
|
||||
versionParam: "--version",
|
||||
versionOutput: tc.Version,
|
||||
extension: "package.json",
|
||||
}
|
||||
env, props := getMockedLanguageEnv(params)
|
||||
yarn := &Yarn{}
|
||||
yarn.Init(props, env)
|
||||
assert.True(t, yarn.Enabled(), fmt.Sprintf("Failed in case: %s", tc.Case))
|
||||
assert.Equal(t, tc.ExpectedString, renderTemplate(env, yarn.Template(), yarn), fmt.Sprintf("Failed in case: %s", tc.Case))
|
||||
}
|
||||
}
|
||||
|
|
@ -375,6 +375,7 @@
|
|||
"winreg",
|
||||
"withings",
|
||||
"xmake",
|
||||
"yarn",
|
||||
"ytm"
|
||||
]
|
||||
},
|
||||
|
|
@ -4639,6 +4640,55 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"type": {
|
||||
"const": "yarn"
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"title": "Yarn Segment",
|
||||
"description": "https://ohmyposh.dev/docs/segments/yarn",
|
||||
"properties": {
|
||||
"properties": {
|
||||
"properties": {
|
||||
"home_enabled": {
|
||||
"$ref": "#/definitions/home_enabled"
|
||||
},
|
||||
"fetch_version": {
|
||||
"$ref": "#/definitions/fetch_version"
|
||||
},
|
||||
"display_mode": {
|
||||
"$ref": "#/definitions/display_mode"
|
||||
},
|
||||
"missing_command_text": {
|
||||
"$ref": "#/definitions/missing_command_text"
|
||||
},
|
||||
"version_url_template": {
|
||||
"$ref": "#/definitions/version_url_template"
|
||||
},
|
||||
"cache_version": {
|
||||
"$ref": "#/definitions/cache_version"
|
||||
},
|
||||
"extensions": {
|
||||
"type": "array",
|
||||
"title": "Extensions",
|
||||
"description": "The extensions to look for when determining if a folder is an Yarn workspace",
|
||||
"default": ["package.json", "yarn.lock"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"folders": {
|
||||
"$ref": "#/definitions/folders"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -15,9 +15,8 @@ import Config from "@site/src/components/Config.js";
|
|||
<Config
|
||||
data={{
|
||||
type: "pnpm",
|
||||
style: "diamond",
|
||||
leading_diamond: "\uE0B2",
|
||||
trailing_diamond: "\uE0D6",
|
||||
style: "powerline",
|
||||
powerline_symbol: "\uE0B0",
|
||||
foreground: "#000000",
|
||||
background: "#F9AD00",
|
||||
template: " \uDB80\uDEC1 {{ .Full }} ",
|
||||
|
|
@ -33,7 +32,7 @@ import Config from "@site/src/components/Config.js";
|
|||
| `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` | `package.json, yarn-lock.yaml` | allows to override the default list of file extensions to validate |
|
||||
| `extensions` | `[]string` | `package.json, pnpm-lock.yaml` | allows to override the default list of file extensions to validate |
|
||||
| `folders` | `[]string` | | allows to override the list of folder names to validate |
|
||||
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
|
||||
|
||||
|
|
|
|||
62
website/docs/segments/yarn.mdx
Normal file
62
website/docs/segments/yarn.mdx
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
id: yarn
|
||||
title: Yarn
|
||||
sidebar_label: Yarn
|
||||
---
|
||||
|
||||
## What
|
||||
|
||||
Display the currently active [yarn][yarn-docs] version.
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
import Config from "@site/src/components/Config.js";
|
||||
|
||||
<Config
|
||||
data={{
|
||||
type: "yarn",
|
||||
style: "powerline",
|
||||
powerline_symbol: "\uE0B0",
|
||||
foreground: "#FFFFFF",
|
||||
background: "#2E2A65",
|
||||
template: " \uDB80\uDD1B {{ .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 Yarn version |
|
||||
| `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` | `package.json, yarn.lock` | allows to override the default list of file extensions to validate |
|
||||
| `folders` | `[]string` | | allows to override the list of folder names to validate |
|
||||
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
|
||||
|
||||
## Template ([info][templates])
|
||||
|
||||
:::note default template
|
||||
|
||||
```template
|
||||
\uDB80\uDD1B {{.Full}}
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| -------- | -------- | -------------------------------------------------- |
|
||||
| `.Full` | `string` | the full version |
|
||||
| `.Major` | `string` | major number |
|
||||
| `.Minor` | `string` | minor number |
|
||||
| `.Patch` | `string` | patch number |
|
||||
| `.URL` | `string` | URL of the version info / release notes |
|
||||
| `.Error` | `string` | error encountered when fetching the version string |
|
||||
|
||||
[go-text-template]: https://golang.org/pkg/text/template/
|
||||
[templates]: /docs/configuration/templates
|
||||
[yarn-docs]: https://yarnpkg.com
|
||||
|
|
@ -138,6 +138,7 @@ module.exports = {
|
|||
"segments/withings",
|
||||
"segments/winreg",
|
||||
"segments/xmake",
|
||||
"segments/yarn",
|
||||
"segments/ytm",
|
||||
],
|
||||
},
|
||||
|
|
|
|||
Loading…
Reference in a new issue