Skip to main content

NPM

What

Display the currently active npm version.

Sample Configuration

{
"type": "npm",
"style": "powerline",
"powerline_symbol": "",
"foreground": "#193549",
"background": "#ffeb3b",
"template": " {{ .Full }} "
}

Properties

NameTypeDefaultDescription
home_enabledbooleanfalsedisplay the segment in the HOME folder or not
fetch_versionbooleantruefetch the NPM version
cache_durationstring24hthe 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_textstringtext to display when the command is missing
display_modestringcontext
  • always: the segment is always displayed
  • files: the segment is only displayed when file extensions listed are present
  • context: displays the segment when the environment or files is active
version_url_templatestringa go text/template template that creates the URL of the version info / release notes
extensions[]stringpackage.json, package-lock.jsonallows to override the default list of file extensions to validate
folders[]stringallows to override the list of folder names to validate

Template (info)

default template
\ue71e {{.Full}}

Properties

NameTypeDescription
.Fullstringthe full version
.Majorstringmajor number
.Minorstringminor number
.Patchstringpatch number
.URLstringURL of the version info / release notes
.Errorstringerror encountered when fetching the version string