Skip to main content

Node

What#

Display the currently active Node.js version.

Sample Configuration#

{
"type": "node",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#ffffff",
"background": "#6CA35E",
"template": " \uE718 {{ .Full }} "
}

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
  • 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 template 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

Template (info)#

default template
{{ if .PackageManagerIcon }}{{ .PackageManagerIcon }} {{ end }}{{ .Full }}

Properties#

  • .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