support require statements with apostrophes (#103)

* fix teambit/bit#1708, support require statements with apostrophes

* bump version

Author: davidfirst

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unreleased]
 
+## [2.0.11] - 2019-06-05
+
+- [#1708](https://github.com/teambit/bit/issues/1708) support `require` with apostrophes
+
 ## [2.0.10] - 2019-05-31
 
 - [#1690](https://github.com/teambit/bit/issues/1690) fix error "Cannot read property 'find' of undefined" with typescript files

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bit-javascript",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "scripts": {
     "flow": "flow; test $? -eq 0 -o $? -eq 2",
     "lint": "eslint src && flow check || true",

src/cli/commands/get-dependencies.js

@@ -4,7 +4,8 @@ import { getDependenciesAction } from '../../actions';
 import { DEFAULT_BINDINGS_PREFIX } from '../../constants';
 
 const report = (data) => {
-  console.log('dependencies', JSON.stringify(data, null, '  '));
+  if (!data) return 'No dependencies found!';
+  return JSON.stringify(data, null, '  ');
 };
 
 const resolveConfig = undefined; // @todo: figure out how to get the data from the command line, maybe as a file

src/dependency-builder/detectives/detective-es6/index.js

@@ -1,3 +1,4 @@
+import { getDependenciesFromMemberExpression, getDependenciesFromCallExpression } from '../parser-helper';
 /**
  * this file had been forked (and changed since then) from https://github.com/dependents/node-detective-es6
  */
@@ -83,32 +84,15 @@ module.exports = function (src) {
         addExportedToImportSpecifier(node.declaration.name);
         break;
       case 'CallExpression':
-        if (node.callee.type === 'Import' && node.arguments.length && node.arguments[0].value) {
-          addDependency(node.arguments[0].value);
-        }
-        if (
-          node.callee.type === 'Identifier' && // taken from detective-cjs
-          node.callee.name === 'require' &&
-          node.arguments[0].value &&
-          node.arguments &&
-          node.arguments.length &&
-          (node.arguments[0].type === 'Literal' || node.arguments[0].type === 'StringLiteral')
-        ) {
-          addDependency(node.arguments[0].value);
+        {
+          const value = getDependenciesFromCallExpression(node);
+          if (value) addDependency(value);
         }
         break;
       case 'MemberExpression':
-        if (
-          node.object.type === 'CallExpression' &&
-          node.object.callee.type === 'Identifier' &&
-          node.object.callee.name === 'require' &&
-          node.object.arguments &&
-          node.object.arguments.length &&
-          node.object.arguments[0].value &&
-          (node.object.arguments[0].type === 'Literal' || node.object.arguments[0].type === 'StringLiteral')
-        ) {
-          const depValue = node.object.arguments[0].value;
-          addDependency(depValue);
+        {
+          const value = getDependenciesFromMemberExpression(node);
+          if (value) addDependency(value);
         }
         break;
       default:

src/dependency-builder/detectives/detective-es6/index.spec.js

@@ -116,6 +116,18 @@ describe('detective-es6', () => {
     });
   });
 
+  describe('string in apostrophes', () => {
+    it('should recognize when using require statement', () => {
+      const deps = detective('const foo = require(`foo`);'); // eslint-disable-line
+      const depsKeys = Object.keys(deps);
+      assert.equal(depsKeys.length, 1);
+      assert.equal(depsKeys[0], 'foo');
+    });
+    it('should throw when using import syntax', () => {
+      expect(() => detective('import foo from `foo`;')).to.throw(); // eslint-disable-line
+    });
+  });
+
   describe('import-specifiers detection (for tree shaking)', () => {
     it('should recognize default imports as default', () => {
       const deps = detective('import foo from "foo";');

src/dependency-builder/detectives/detective-typescript/index.js

@@ -1,6 +1,7 @@
 /**
  * this file had been forked from https://github.com/pahen/detective-typescript
  */
+import { getDependenciesFromMemberExpression, getDependenciesFromCallExpression } from '../parser-helper';
 
 const Parser = require('@typescript-eslint/typescript-estree');
 const Walker = require('node-source-walk');
@@ -81,30 +82,15 @@ module.exports = function (src, options = {}) {
         }
         break;
       case 'CallExpression':
-        if (node.callee.type === 'Import' && node.arguments.length) {
-          addDependency(node.arguments[0].value);
-        }
-        if (
-          node.callee.type === 'Identifier' && // taken from detective-cjs
-          node.callee.name === 'require' &&
-          node.arguments &&
-          node.arguments.length &&
-          (node.arguments[0].type === 'Literal' || node.arguments[0].type === 'StringLiteral')
-        ) {
-          addDependency(node.arguments[0].value);
+        {
+          const value = getDependenciesFromCallExpression(node);
+          if (value) addDependency(value);
         }
         break;
       case 'MemberExpression':
-        if (
-          node.object.type === 'CallExpression' &&
-          node.object.callee.type === 'Identifier' &&
-          node.object.callee.name === 'require' &&
-          node.object.arguments &&
-          node.object.arguments.length &&
-          (node.object.arguments[0].type === 'Literal' || node.object.arguments[0].type === 'StringLiteral')
-        ) {
-          const depValue = node.object.arguments[0].value;
-          addDependency(depValue);
+        {
+          const value = getDependenciesFromMemberExpression(node);
+          if (value) addDependency(value);
         }
         break;
       default:

src/dependency-builder/detectives/detective-typescript/index.spec.js

@@ -119,4 +119,13 @@ describe('detective-typescript', () => {
       detective("import './layout.scss'; export default something;");
     });
   });
+
+  describe('string in apostrophes', () => {
+    it('should recognize when using require statement', () => {
+      const deps = detective('const foo = require(`foo`);'); // eslint-disable-line
+      const depsKeys = Object.keys(deps);
+      assert.equal(depsKeys.length, 1);
+      assert.equal(depsKeys[0], 'foo');
+    });
+  });
 });

src/dependency-builder/detectives/parser-helper.js

@@ -0,0 +1,44 @@
+export function getDependenciesFromMemberExpression(node) {
+  if (
+    node.object.type === 'CallExpression' &&
+    node.object.callee.type === 'Identifier' &&
+    node.object.callee.name === 'require' &&
+    node.object.arguments &&
+    node.object.arguments.length
+  ) {
+    return getStringValue(node.object.arguments[0]);
+  }
+  return null;
+}
+
+export function getDependenciesFromCallExpression(node) {
+  if (node.callee.type === 'Import' && node.arguments.length && node.arguments[0].value) {
+    return node.arguments[0].value;
+  }
+  if (
+    node.callee.type === 'Identifier' && // taken from detective-cjs
+    node.callee.name === 'require' &&
+    node.arguments &&
+    node.arguments.length
+  ) {
+    return getStringValue(node.arguments[0]);
+  }
+  return null;
+}
+
+function getStringValue(node) {
+  // using single or double quotes (', ")
+  if (node.type === 'Literal' || node.type === 'StringLiteral') {
+    return node.value;
+  }
+  // using apostrophe (`)
+  if (
+    node.type === 'TemplateLiteral' &&
+    node.quasis &&
+    node.quasis.length &&
+    node.quasis[0].type === 'TemplateElement'
+  ) {
+    return node.quasis[0].value.raw;
+  }
+  return null;
+}