Skip to content

doc: include global node_modules in require.resolve description #20534

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

Closed
musgravejw wants to merge 3 commits into from
Closed

doc: include global node_modules in require.resolve description #20534

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7967eca
doc: include global node_modules in require.resolve description
musgravejw May 5, 2018
263ad12
doc: rerence GLOBAL_FOLDERS and link to folder list
musgravejw May 5, 2018
c7e33fe
doc: replace '~' with '$HOME', refactor
musgravejw May 8, 2018
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
11 changes: 6 additions & 5 deletions doc/api/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Sign in to view

This comment was marked as resolved.

Sign in to view

4. while I >= 0,
a. if PARTS[I] = "node_modules" CONTINUE
b. DIR = path join(PARTS[0 .. I] + "node_modules")
Expand Down Expand Up @@ -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
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt May 9, 2018

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,
Expand Down Expand Up @@ -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