-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(node): add Yarn segment and fix PNPM docs
- Loading branch information
1 parent
e25d271
commit 9b62e69
Showing
7 changed files
with
184 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 }}", | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters