prezto/modules/node/README.md

# Node.js

Provides utility functions for [Node.js][1], loads the Node Version Manager, and
enables [_npm_][2] completion.

## nvm

[_nvm_][5] 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_][6] 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_][7].

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][3] 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.

```sh
# %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][4]._

- [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Zeh Rizzatti](https://github.com/zehrizzatti)

[1]: http://nodejs.org
[2]: http://npmjs.org
[3]: http://nodejs.org/api
[4]: https://github.com/sorin-ionescu/prezto/issues
[5]: https://github.com/creationix/nvm
[6]: https://github.com/nodenv/nodenv
[7]: https://github.com/sstephenson/rbenv
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://'). 4 years ago			`# Node.js`
[Fix #108] Add documentation for node 13 years ago
Add support for nvm 12 years ago			`Provides utility functions for [Node.js][1], loads the Node Version Manager, and`
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 4 years ago			`enables [_npm_][2] completion.`
Add support for nvm 12 years ago
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://'). 4 years ago			`## nvm`
Add support for nvm 12 years ago
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 4 years ago			`[_nvm_][5] allows for managing multiple, isolated Node.js installations in the`
Add support for nvm 12 years ago			`home directory.`
[Fix #108] Add documentation for node 13 years ago
node, python, ruby: update docs about new envars 5 years ago			This will be loaded automatically if nvm is installed in `$NVM_DIR`,
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 4 years ago			_`~/.nvm`_, or nvm is installed with Homebrew.
node, python, ruby: update docs about new envars 5 years ago
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://'). 4 years ago			`## nodenv`
Add nodenv support to Node.js module - Implementation from https://github.com/sorin-ionescu/prezto/pull/1001 - Documentation from https://github.com/sorin-ionescu/prezto/pull/1178 8 years ago
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 4 years ago			`[_nodenv_][6] does one thing well - it is concerned solely with switching`
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://'). 4 years ago			`Node versions. It is simple and predictable, Just Works, and is rock solid in`
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 4 years ago			`production. nodenv is forked from the popular [_rbenv_][7].`
Add nodenv support to Node.js module - Implementation from https://github.com/sorin-ionescu/prezto/pull/1001 - Documentation from https://github.com/sorin-ionescu/prezto/pull/1178 8 years ago
node, python, ruby: update docs about new envars 5 years ago			This will be loaded automatically if nodenv is installed in `$NODENV_ROOT`,
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 4 years ago			_`~/.nodenv`_, or `nodenv` is on the path.
node, python, ruby: update docs about new envars 5 years ago
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://'). 4 years ago			`## Functions`
[Fix #108] Add documentation for node 13 years ago
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://'). 4 years ago			- `node-doc` opens the Node.js online [API documentation][3] in the default
			`browser.`
			- `node-info` exposes information about the Node.js environment via the
			`$node_info` associative array.
Add support for nvm 12 years ago
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://'). 4 years ago			`## Theming`
Add support for nvm 12 years ago
			`To display the version number of the current Node.js version, define the`
			following style inside the `prompt_name_setup` function.

[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes 7 years ago			```sh
			`# %v - Node.js version.`
			`zstyle ':prezto:module:node:info:version' format 'version:%v'`
			```
Add support for nvm 12 years ago
			Then add `$node_info[version]` to either `$PROMPT` or `$RPROMPT` and call
			`node-info` in `prompt_name_preexec` hook function.
[Fix #108] Add documentation for node 13 years ago
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://'). 4 years ago			`## Authors`
[Fix #108] Add documentation for node 13 years ago
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 4 years ago			`_The authors of this module should be contacted via the [issue tracker][4]._`
[Fix #108] Add documentation for node 13 years ago
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://'). 4 years ago			`- [Sorin Ionescu](https://github.com/sorin-ionescu)`
			`- [Zeh Rizzatti](https://github.com/zehrizzatti)`
[Fix #108] Add documentation for node 13 years ago
			`[1]: http://nodejs.org`
			`[2]: http://npmjs.org`
			`[3]: http://nodejs.org/api`
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv 12 years ago			`[4]: https://github.com/sorin-ionescu/prezto/issues`
Add support for nvm 12 years ago			`[5]: https://github.com/creationix/nvm`
Add nodenv support to Node.js module - Implementation from https://github.com/sorin-ionescu/prezto/pull/1001 - Documentation from https://github.com/sorin-ionescu/prezto/pull/1178 8 years ago			`[6]: https://github.com/nodenv/nodenv`
			`[7]: https://github.com/sstephenson/rbenv`