oh-my-posh/website/docs/segments/npm.md

1.5 KiB

id title sidebar_label
npm NPM NPM

What

Display the currently active npm version.

Sample Configuration

{
  "type": "npm",
  "style": "powerline",
  "powerline_symbol": "\uE0B0",
  "foreground": "#193549",
  "background": "#ffeb3b",
  "template": "\ue71e {{ .Full }} "
}

Properties

  • home_enabled: boolean - display the segment in the HOME folder or not - defaults to false
  • missing_command_text: string - text to display when the command is missing - defaults to empty
  • fetch_version: boolean - fetch the NPM version - defaults to true
  • display_mode: string - determines when the segment is displayed
    • always: the segment is always displayed
    • files: the segment is only displayed when package.json or package-lock.json file are present
  • version_url_template: string - a go text/template template that creates the URL of the version info / release notes

Template (info)

:::note default template

\ue71e {{.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