catering for nested/local node_modules

Author: walisc

index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const fs = require('node:fs');
+const path = require('node:path');
 const { debuglog } = require('node:util');
 const cabinet = require('filing-cabinet');
 const precinct = require('precinct');
@@ -161,6 +162,7 @@ function traverse(config = {}) {
   for (const dependency of dependencies) {
     const localConfig = config.clone();
     localConfig.filename = dependency;
+    localConfig.directory = getDirectory(localConfig);
 
     if (localConfig.isListForm) {
       for (const item of traverse(localConfig)) {
@@ -192,3 +194,26 @@ function dedupeNonExistent(nonExistent) {
     i++;
   }
 }
+
+//If the file is in a node module, use the root directory of the module
+function getDirectory(localConfig){
+  function _getProjectPath(filename) {
+      try{
+        const nodeModuleParts = filename.split('node_modules')
+        const packageSubPathPath = nodeModuleParts.pop().split(path.sep).filter(function(v){ return !!v})
+        const packageName = packageSubPathPath[0].startsWith("@") ? `${packageSubPathPath[0]}${path.sep}${packageSubPathPath[1]}` :  packageSubPathPath[0]
+
+        return path.join(...nodeModuleParts, 'node_modules', packageName)
+      }
+      catch(err){
+        debug(`Could not determine the root directory of package file ${filename}. Using default`);
+        return null
+      }
+  }
+
+  if (!localConfig.filename.includes('node_modules')){
+    return localConfig.directory
+  }
+
+  return _getProjectPath(path.dirname(localConfig.filename)) || localConfig.directory
+}

test/test.mjs

@@ -472,6 +472,79 @@ describe('dependencyTree', () => {
     });
   });
 
+  describe("It uses package specific node_module directory when resolving package dependencies", () => {
+    testTreesForFormat('commonjs');
+
+    it('It can find sub package in node module package', () => {
+      mockfs({
+        [path.join(__dirname, '/es6')]: {
+          'module.entry.js': 'import * as module from "parent_module_a"',
+          node_modules: { // eslint-disable-line camelcase
+            'parent_module_a': {
+              'index.main.js': 'import * as child_module from "child_node_module"; module.exports = child_module;',
+              'package.json': '{ "main": "index.main.js"}',
+              node_modules: {
+                child_node_module: {
+                  'index.main.js': 'module.exports = "child_node_module_of_parent_a"',
+                  'package.json': '{ "main": "index.main.js"}',
+                }
+              }
+            }
+          }
+        }
+      });
+
+      const directory = path.join(__dirname, '/es6');
+      const filename = path.normalize(`${directory}/module.entry.js`);
+
+      const treeList = dependencyTree({
+        filename,
+        directory,
+        isListForm: true
+      });
+
+      assert.ok(treeList.includes(path.normalize(`${directory}/node_modules/parent_module_a/node_modules/child_node_module/index.main.js`)));
+    });
+
+
+    it('it usues correct version of sub package in node module package', () => {
+      mockfs({
+        [path.join(__dirname, '/es6')]: {
+          'module.entry.js': 'import * as module from "parent_module_a"',
+          node_modules: { // eslint-disable-line camelcase
+            child_node_module: {
+              'index.main.js': 'module.exports = "child_node_module"',
+              'package.json': '{ "main": "index.main.js", "version": "2.0.0"}',
+            },
+            parent_module_a: {
+              'index.main.js': 'import * as child_module from "child_node_module"; module.exports = child_module;',
+              'package.json': '{ "main": "index.main.js"}',
+              node_modules: {
+                child_node_module: {
+                  'index.main.js': 'module.exports = "child_node_module_of_parent_a"',
+                  'package.json': '{ "main": "index.main.js", "version": "1.0.0"}',
+                }
+              }
+            }
+          }
+        }
+      });
+
+      const directory = path.join(__dirname, '/es6');
+      const filename = path.normalize(`${directory}/module.entry.js`);
+
+      const treeList = dependencyTree({
+        filename,
+        directory,
+        isListForm: true
+      });
+
+      assert.ok(!treeList.includes(path.normalize(`${directory}/node_modules/child_node_module/index.main.js`)));
+      assert.ok(treeList.includes(path.normalize(`${directory}/node_modules/parent_module_a/node_modules/child_node_module/index.main.js`)));
+
+    });
+  })
+  
   describe('module formats', () => {
     describe('amd', () => {
       testTreesForFormat('amd');