prezto/modules/node/README.md
Indrajit Raychaudhuri d80e393f78 general: Reformat documentation with better formatting and wording
General purpose reformating and rewording in (a few places). This should
also make markdown linting happier.

Prefer back-ticks wherever useful and use `console` for code blocks to
be executed on terminal.

Also, update references links wherever possible (including update from
'http://' to 'https://').
2021-05-05 12:21:04 -05:00

1.7 KiB

Node.js

Provides utility functions for Node.js, loads the Node Version Manager, and enables npm completion.

nvm

nvm allows for managing multiple, isolated Node.js installations in the home directory.

This will be loaded automatically if nvm is installed in $NVM_DIR, ~/.nvm, or nvm is installed with homebrew.

nodenv

nodenv does one thing well - it is concerned solely with switching Node versions. It is simple and predictable, Just Works, and is rock solid in production. nodenv is forked from the popular rbenv.

This will be loaded automatically if nodenv is installed in $NODENV_ROOT, ~/.nodenv, or nodenv is on the path.

Functions

  • node-doc opens the Node.js online API documentation in the default browser.
  • node-info exposes information about the Node.js environment via the $node_info associative array.

Theming

To display the version number of the current Node.js version, define the following style inside the prompt_name_setup function.

# %v - Node.js version.
zstyle ':prezto:module:node:info:version' format 'version:%v'

Then add $node_info[version] to either $PROMPT or $RPROMPT and call node-info in prompt_name_preexec hook function.

Authors

The authors of this module should be contacted via the issue tracker.