1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add global node_modules to require.resolve()

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/20534
Fixes: https://github.com/nodejs/node/issues/18926
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This commit is contained in:
musgravejw 2018-05-05 01:43:12 -04:00 committed by Vse Mozhet Byt
parent 3706c65500
commit 6fd8022641
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/api/modules.md
View File

@ -175,7 +175,7 @@ LOAD_AS_DIRECTORY(X)
2. LOAD_INDEX(X) 2. LOAD_INDEX(X)
LOAD_NODE_MODULES(X, START) LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START) 1. let DIRS = NODE_MODULES_PATHS(START)
2. for each DIR in DIRS: 2. for each DIR in DIRS:
a. LOAD_AS_FILE(DIR/X) a. LOAD_AS_FILE(DIR/X)
b. LOAD_AS_DIRECTORY(DIR/X) b. LOAD_AS_DIRECTORY(DIR/X)
@ -183,7 +183,7 @@ LOAD_NODE_MODULES(X, START)
NODE_MODULES_PATHS(START) NODE_MODULES_PATHS(START)
1. let PARTS = path split(START) 1. let PARTS = path split(START)
2. let I = count of PARTS - 1 2. let I = count of PARTS - 1
3. let DIRS = [] 3. let DIRS = [GLOBAL_FOLDERS]
4. while I >= 0, 4. while I >= 0,
a. if PARTS[I] = "node_modules" CONTINUE a. if PARTS[I] = "node_modules" CONTINUE
b. DIR = path join(PARTS[0 .. I] + "node_modules") b. DIR = path join(PARTS[0 .. I] + "node_modules")
@ -419,7 +419,7 @@ when people are unaware that `NODE_PATH` must be set. Sometimes a
module's dependencies change, causing a different version (or even a module's dependencies change, causing a different version (or even a
different module) to be loaded as the `NODE_PATH` is searched. different module) to be loaded as the `NODE_PATH` is searched.
Additionally, Node.js will search in the following locations: Additionally, Node.js will search in the following list of GLOBAL_FOLDERS:
* 1: `$HOME/.node_modules` * 1: `$HOME/.node_modules`
* 2: `$HOME/.node_libraries` * 2: `$HOME/.node_libraries`
@ -649,9 +649,11 @@ changes:
* `request` {string} The module path to resolve. * `request` {string} The module path to resolve.
* `options` {Object} * `options` {Object}
* `paths` {string[]} Paths to resolve module location from. If present, these * `paths` {string[]} Paths to resolve module location from. If present, these
paths are used instead of the default resolution paths. Note that each of paths are used instead of the default resolution paths, with the exception
these paths is used as a starting point for the module resolution algorithm, of [GLOBAL_FOLDERS][] like `$HOME/.node_modules`, which are always
meaning that the `node_modules` hierarchy is checked from this location. 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} * Returns: {string}
Use the internal `require()` machinery to look up the location of a module, Use the internal `require()` machinery to look up the location of a module,
@ -891,6 +893,7 @@ const builtin = require('module').builtinModules;
[`Error`]: errors.html#errors_class_error [`Error`]: errors.html#errors_class_error
[`module` object]: #modules_the_module_object [`module` object]: #modules_the_module_object
[`path.dirname()`]: path.html#path_path_dirname_path [`path.dirname()`]: path.html#path_path_dirname_path
[GLOBAL_FOLDERS]: #modules_loading_from_the_global_folders
[exports shortcut]: #modules_exports_shortcut [exports shortcut]: #modules_exports_shortcut
[module resolution]: #modules_all_together [module resolution]: #modules_all_together
[module wrapper]: #modules_the_module_wrapper [module wrapper]: #modules_the_module_wrapper