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.

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

Conversation

smikes
Copy link
Contributor

@smikes smikes commented May 14, 2015

Addresses #1627

@brendanashworth brendanashworth added the doc Issues and PRs related to the documentations. label May 14, 2015
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.

@silverwind silverwind self-assigned this May 17, 2015
@silverwind
Copy link
Contributor

LGTM

@silverwind silverwind removed their assignment May 17, 2015
silverwind pushed a commit that referenced this pull request May 17, 2015
PR-URL: #1708
Reviewed-By: Roman Reiss <me@silverwind.io>
@silverwind
Copy link
Contributor

landed in 7d90c90

@silverwind silverwind closed this May 17, 2015
andrewdeandrade pushed a commit to andrewdeandrade/node that referenced this pull request Jun 3, 2015
PR-URL: nodejs/node#1708
Reviewed-By: Roman Reiss <me@silverwind.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants