Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: recommend against use of node_path #1708

Closed
wants to merge 2 commits into from
Closed

doc: recommend against use of node_path #1708

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d412beb
doc: recommend against use of node_path
smikes May 14, 2015
978fbd0
add bolding and anchor
smikes May 15, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/api/modules.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,18 @@ of absolute paths, then io.js will search those paths for modules if they
are not found elsewhere. (Note: On Windows, `NODE_PATH` is delimited by
semicolons instead of colons.)

`NODE_PATH` was originally created to support loading modules from
varying paths before the current
[module resolution](https://iojs.org/api/modules.html) algorithm was
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This links back to the document itself – perhaps this is missing an anchor?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could possible link to https://iojs.org/api/modules.html#modules_all_together, although I don't really like this header name :)

frozen.

`NODE_PATH` is still supported, but is less necessary now that the io.js
ecosystem has settled on a convention for locating dependent modules.
Sometimes deployments that rely on `NODE_PATH` show surprising behavior
when people are unaware that `NODE_PATH` must be set. Sometimes a
module's dependencies change, causing a different version (or even a
different module) to be loaded as the `NODE_PATH` is searched.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We go on in the document to suggest using NODE_PATH to make global modules require-able in the REPL – we should probably nix that.

I'd also suggest bolding the line below, "You are highly encouraged to place your dependencies locally in node_modules folders."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd move this disclaimer about global modules to the top of this section, possibly bolding it.


Additionally, io.js will search in the following locations:

* 1: `$HOME/.node_modules`
Expand Down