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: include global node_modules in require.resolve description #20534

Closed
wants to merge 3 commits into from
Closed
Changes from 1 commit
Commits
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
Prev Previous commit
doc: replace '~' with '$HOME', refactor
musgravejw committed May 9, 2018
commit c7e33fe7b9ad56f422fa32c8b0044871bf50633e
11 changes: 6 additions & 5 deletions doc/api/modules.md
Original file line number Diff line number Diff line change
@@ -183,7 +183,7 @@ LOAD_NODE_MODULES(X, START)
NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = [GLOBAL_FOLDERS](#modules_loading_from_the_global_folders)
3. let DIRS = [GLOBAL_FOLDERS]

This comment was marked as resolved.

This comment was marked as resolved.

4. while I >= 0,
a. if PARTS[I] = "node_modules" CONTINUE
b. DIR = path join(PARTS[0 .. I] + "node_modules")
@@ -650,10 +650,10 @@ changes:
* `options` {Object}
* `paths` {string[]} Paths to resolve module location from. If present, these
paths are used instead of the default resolution paths, with the exception
of [GLOBAL_FOLDERS](#modules_loading_from_the_global_folders) like
`~/.node_modules`, which are always included. Note that each of these paths
is used as a starting point for the module resolution algorithm, meaning
that the `node_modules` hierarchy is checked from this location.
of [GLOBAL_FOLDERS][] like `$HOME/.node_modules`, which are always
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: trailing space, but this can be fixed on landing)

included. Note that each of these paths is used as a starting point for
the module resolution algorithm, meaning that the `node_modules` hierarchy
is checked from this location.
* Returns: {string}

Use the internal `require()` machinery to look up the location of a module,
@@ -897,3 +897,4 @@ const builtin = require('module').builtinModules;
[module resolution]: #modules_all_together
[module wrapper]: #modules_the_module_wrapper
[native addons]: addons.html
[GLOBAL_FOLDERS]: #modules_loading_from_the_global_folders