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

doc: fix modules require.resolve documentation

Browse Source 
The behavior of the `node_modules` lookup algorithm was
changed in #1177, but the documentation was not updated completely
to describe the new behavior.

The pseudocode of the lookup algorithm did not metion that
`index.json` is tried to be loaded if you require a folder.

Reviewed-By: Fedor Indutny <fedor@indutny.com>
This commit is contained in:
Mathias Schreck 2014-09-03 13:45:36 +02:00 committed by Fedor Indutny
parent 627c1a92eb
commit 7c5fabe405
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/api/modules.markdown
View File

@ -161,7 +161,7 @@ parent directory of the current module, and adds `/node_modules`, and
attempts to load the module from that location. attempts to load the module from that location.
If it is not found there, then it moves to the parent directory, and so If it is not found there, then it moves to the parent directory, and so
on, until the root of the tree is reached. on, until the root of the file system is reached.
For example, if the file at `'/home/ry/projects/foo.js'` called For example, if the file at `'/home/ry/projects/foo.js'` called
`require('bar.js')`, then node would look in the following locations, in `require('bar.js')`, then node would look in the following locations, in
@ -394,7 +394,8 @@ in pseudocode of what require.resolve does:
b. let M = X + (json main field) b. let M = X + (json main field)
c. LOAD_AS_FILE(M) c. LOAD_AS_FILE(M)
2. If X/index.js is a file, load X/index.js as JavaScript text. STOP 2. If X/index.js is a file, load X/index.js as JavaScript text. STOP
3. If X/index.node is a file, load X/index.node as binary addon. STOP 3. If X/index.json is a file, parse X/index.json to a JavaScript object. STOP
4. If X/index.node is a file, load X/index.node as binary addon. STOP
LOAD_NODE_MODULES(X, START) LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START) 1. let DIRS=NODE_MODULES_PATHS(START)
@ -404,15 +405,14 @@ in pseudocode of what require.resolve does:
NODE_MODULES_PATHS(START) NODE_MODULES_PATHS(START)
1. let PARTS = path split(START) 1. let PARTS = path split(START)
2. let ROOT = index of first instance of "node_modules" in PARTS, or 0 2. let I = count of PARTS - 1
3. let I = count of PARTS - 1 3. let DIRS = []
4. let DIRS = [] 4. while I >= 0,
5. while I > ROOT,
a. if PARTS[I] = "node_modules" CONTINUE a. if PARTS[I] = "node_modules" CONTINUE
c. DIR = path join(PARTS[0 .. I] + "node_modules") c. DIR = path join(PARTS[0 .. I] + "node_modules")
b. DIRS = DIRS + DIR b. DIRS = DIRS + DIR
c. let I = I - 1 c. let I = I - 1
6. return DIRS 5. return DIRS
## Loading from the global folders ## Loading from the global folders