oh-my-posh/website/docs/segments/node.mdx

63 lines
2.1 KiB
Plaintext
Raw Normal View History

2020-10-05 02:33:12 -07:00
---
id: node
title: Node
sidebar_label: Node
---
## What
Display the currently active [Node.js][node-js] version.
2020-10-05 02:33:12 -07:00
## Sample Configuration
```json
{
"type": "node",
"style": "powerline",
2020-10-15 23:37:43 -07:00
"powerline_symbol": "\uE0B0",
2020-10-05 02:33:12 -07:00
"foreground": "#ffffff",
"background": "#6CA35E",
2022-03-27 01:12:47 -07:00
"template": " \uE718 {{ .Full }} "
2020-10-05 02:33:12 -07:00
}
```
2020-10-22 04:47:42 -07:00
## Properties
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
- fetch_version: `boolean` - display the Node.js version - defaults to `true`
2020-12-31 22:15:19 -08:00
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
- display_mode: `string` - determines when the segment is displayed
- `always`: The segment is always displayed
- `files`: The segment is only displayed when `*.js`, `*.ts`, `package.json`, `.nvmrc`, `pnpm-workspace.yaml`,
`.pnpmfile.cjs`, `.npmrc` or `.vue` files are present (default)
- version_url_template: `string` - a go [text/template][go-text-template] [template][templates] that creates
the URL of the version info / release notes
- fetch_package_manager: `boolean` - define if the current project uses Yarn or NPM - defaults to `false`
- yarn_icon: `string` - the icon/text to display when using Yarn - defaults to ` \uF61A`
- npm_icon: `string` - the icon/text to display when using NPM - defaults to ` \uE71E`
2021-12-03 11:36:30 -08:00
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
``` template
{{ if .PackageManagerIcon }}{{ .PackageManagerIcon }} {{ end }}{{ .Full }}
```
:::
### Properties
2021-12-03 11:36:30 -08:00
- `.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
- `.PackageManagerIcon`: `string` - the Yarn on NPM icon when setting `fetch_package_manager` to `true`
- `.Mismatch`: `boolean` - if the version in `.nvmrc` matches with `.Full`
2021-12-03 11:36:30 -08:00
[go-text-template]: https://golang.org/pkg/text/template/
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates
[node-js]: https://nodejs.org