dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-22 08:08:00 +00:00
Code Issues Releases Wiki Activity
74a19fb665
prezto/modules/node
History
Indrajit Raychaudhuri 8ee9d1bbfe general: Documentation update for zstyle based alias skipping support 
Add documentation to surface the `zstyle` based alias skipping.
2023-05-17 02:39:09 -05:00
..
functions node: Optimize completions for loading lazily on demand 2021-05-21 13:39:23 -05:00
init.zsh Add zstyle to skip aliases for additional modules 2023-04-13 09:33:48 -07:00
README.md general: Documentation update for zstyle based alias skipping support 2023-05-17 02:39:09 -05:00

README.md

Node.js

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

This module must be loaded before the completion module so that the provided completion definitions are loaded.

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, $XDG_CONFIG_HOME/nodenv, ~/.nodenv, or nodenv is on the path.

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, $XDG_CONFIG_HOME/nvm, ~/.nvm, or is installed with homebrew.

Variables

  • N_PREFIX stores the path to n cache.

Aliases

Aliases are enabled by default. To disable them, add the following to ${ZDOTDIR:-$HOME}/.zpreztorc.

zstyle ':prezto:module:node:alias' skip 'yes'

npm

  • npmi install a package.

  • npml list installed packages.

  • npmo check for outdated packages.

  • npmp publish a package.

  • npmP remove extraneous packages.

  • npmr run arbitrary package scripts.

  • npms search for packages.

  • npmt test a package.

  • npmu update packages.

  • npmx uninstalls a package.

  • npmci install a project with a clean slate.

  • npmcit install a project with a clean slate and run tests.

  • npmit install package(s) and run tests.

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.