Merge pull request #23 from codemonkey800/master

Add support for mixed imports in TypeScript

Author: pahen

README.md

@@ -16,6 +16,11 @@ var dependencies = detective(mySourceCode);
 
 ```
 
+### Options
+
+- `skipTypeImports` (default: false) - Skips imports that only imports types
+- `mixedImports`: (default: false) - Include CJS imports in dependency list
+
 #### License
 
 MIT

index.js

@@ -2,6 +2,7 @@
 
 const Parser = require('@typescript-eslint/typescript-estree');
 const Walker = require('node-source-walk');
+const types = require('ast-module-types');
 
 /**
  * Extracts the dependencies of the supplied TypeScript module
@@ -19,6 +20,9 @@ module.exports = function(src, options = {}) {
   // Remove skipTypeImports option, as this option may not be recognized by the walker/parser
   delete walkerOptions.skipTypeImports;
 
+  const mixedImports = Boolean(options.mixedImports);
+  delete walkerOptions.mixedImports;
+
   const walker = new Walker(walkerOptions);
 
   const dependencies = [];
@@ -58,6 +62,23 @@ module.exports = function(src, options = {}) {
         if (!skipTypeImports && node.parameter.type === 'TSLiteralType') {
           dependencies.push(node.parameter.literal.value);
         }
+        break;
+      case 'CallExpression':
+        if (!mixedImports || !types.isRequire(node) ||
+            !node.arguments ||
+            !node.arguments.length) {
+          break;
+        }
+
+        if (types.isPlainRequire(node)) {
+          const result = extractDependencyFromRequire(node);
+          if (result) {
+            dependencies.push(result);
+          }
+        } else if (types.isMainScopedRequire(node)) {
+          dependencies.push(extractDependencyFromMainRequire(node));
+        }
+
         break;
       default:
         return;
@@ -67,6 +88,18 @@ module.exports = function(src, options = {}) {
   return dependencies;
 };
 
-module.exports.tsx = function(src, options = {jsx: true}) {
-  return module.exports(src, options);
+module.exports.tsx = function(src, options) {
+  return module.exports(src, Object.assign({}, options, { jsx: true }));
 };
+
+function extractDependencyFromRequire(node) {
+  if (node.arguments[0].type === 'Literal' || node.arguments[0].type === 'StringLiteral') {
+    return node.arguments[0].value;
+  } else if (node.arguments[0].type === 'TemplateLiteral') {
+    return node.arguments[0].quasis[0].value.raw;
+  }
+}
+
+function extractDependencyFromMainRequire(node) {
+  return node.arguments[0].value;
+}

package-lock.json

@@ -26,6 +26,7 @@
   "homepage": "https://github.com/pahen/detective-typescript",
   "dependencies": {
     "@typescript-eslint/typescript-estree": "^2.4.0",
+    "ast-module-types": "^2.5.0",
     "node-source-walk": "^4.2.0",
     "typescript": "^3.6.4"
   },

package.json

@@ -131,4 +131,9 @@ describe('detective-typescript', () => {
     assert(deps.length === 0);
   });
 
+  it('supports CJS when mixedImports is true', () => {
+    const deps = detective('const foo = require("foobar")', { mixedImports: true });
+    assert(deps.length === 1);
+    assert(deps[0] === 'foobar');
+  })
 });