diff options
| author | Mathias Schreck <schreck.mathias@googlemail.com> | 2014-09-03 13:45:36 +0200 |
|---|---|---|
| committer | Fedor Indutny <fedor@indutny.com> | 2014-09-15 17:17:05 +0400 |
| commit | 7c5fabe4053c82806b0a22437bceab8aa7465b78 (patch) | |
| tree | 970a4c49f82c13584c919d707f118e5b6597cf57 | |
| parent | 627c1a92ebc3be841becd01937aa273bc73ba0a5 (diff) | |
| download | nodejs-7c5fabe4053c82806b0a22437bceab8aa7465b78.tar.gz nodejs-7c5fabe4053c82806b0a22437bceab8aa7465b78.tar.bz2 nodejs-7c5fabe4053c82806b0a22437bceab8aa7465b78.zip | |
doc: fix modules require.resolve documentation
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>
| -rw-r--r-- | doc/api/modules.markdown | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/modules.markdown b/doc/api/modules.markdown index 7632d30e5..2e08ae172 100644 --- a/doc/api/modules.markdown +++ b/doc/api/modules.markdown @@ -161,7 +161,7 @@ parent directory of the current module, and adds `/node_modules`, and attempts to load the module from that location. 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 `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) c. LOAD_AS_FILE(M) 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) 1. let DIRS=NODE_MODULES_PATHS(START) @@ -404,15 +405,14 @@ in pseudocode of what require.resolve does: NODE_MODULES_PATHS(START) 1. let PARTS = path split(START) - 2. let ROOT = index of first instance of "node_modules" in PARTS, or 0 - 3. let I = count of PARTS - 1 - 4. let DIRS = [] - 5. while I > ROOT, + 2. let I = count of PARTS - 1 + 3. let DIRS = [] + 4. while I >= 0, a. if PARTS[I] = "node_modules" CONTINUE c. DIR = path join(PARTS[0 .. I] + "node_modules") b. DIRS = DIRS + DIR c. let I = I - 1 - 6. return DIRS + 5. return DIRS ## Loading from the global folders |