@loopback/build 2.0.16 → 2.1.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.1.0](https://github.com/strongloop/loopback-next/compare/@loopback/build@2.0.16...@loopback/build@2.1.0) (2019-11-25)
+
+
+### Features
+
+* **build:** add an option to control resolution of CLI module from project dependencies ([0715a91](https://github.com/strongloop/loopback-next/commit/0715a91d0eef02c7e259cbd1b62a09010995c796))
+
+
+
+
+
 ## [2.0.16](https://github.com/strongloop/loopback-next/compare/@loopback/build@2.0.15...@loopback/build@2.0.16) (2019-11-12)
 
 **Note:** Version bump only for package @loopback/build

package/bin/utils.js

@@ -56,14 +56,62 @@ function getConfigFile(name, defaultName) {
 
 /**
  * Resolve the path of the cli command
- * @param {string} cli
+ * @param {string} cli CLI module path
+ * @param {object} options Options for module resolution
+ * - `resolveFromProjectFirst`: Try to resolve the CLI path from the package
+ *   dependencies of the current project first instead of `@loopback/build`
  */
-function resolveCLI(cli) {
-  const modulePath = './node_modules/' + cli;
+function resolveCLI(cli, options = {resolveFromProjectFirst: true}) {
+  const {resolveFromProjectFirst = true} = options;
+  if (resolveFromProjectFirst === false) {
+    return require.resolve(cli);
+  }
   try {
-    return require.resolve(path.join(getPackageDir(), modulePath));
+    const pkgDir = getPackageDir();
+    const resolved = resolveCLIFromProject(cli, pkgDir);
+    if (resolved != null) return resolved;
   } catch (e) {
-    return require.resolve(cli);
+    // Ignore errors
+  }
+  return require.resolve(cli);
+}
+
+/**
+ * Parse the package name from the cli module path
+ * @param {string} cli CLI module path, such as `typescript/lib/tsc`
+ */
+function getPackageName(cli) {
+  const paths = cli.split('/');
+  if (paths[0].startsWith('@')) {
+    // The package name is `@<org>/<pkg>`
+    return `${paths[0]}/${paths[1]}`;
+  } else {
+    // The package name is `<pkg>`
+    return paths[0];
+  }
+}
+
+/**
+ * Resolve the cli from the current project
+ * @param {string} cli CLI module path, such as `typescript/lib/tsc`
+ * @param {string} projectRootDir The root directory for the project
+ */
+function resolveCLIFromProject(cli, projectRootDir = getPackageDir()) {
+  const cliPkg = getPackageName(cli);
+  debug(`Trying to resolve CLI module '%s' from %s`, cliPkg, projectRootDir);
+  // Try to load `package.json` for the current project
+  const pkg = require(path.join(projectRootDir, 'package.json'));
+  if (
+    (pkg.devDependencies && pkg.devDependencies[cliPkg]) ||
+    (pkg.dependencies && pkg.dependencies[cliPkg])
+  ) {
+    // The cli package is found in the project dependencies
+    const modulePath = './node_modules/' + cli;
+    const cliModule = require.resolve(path.join(projectRootDir, modulePath));
+    debug(`Resolved CLI module '%s': %s`, cliPkg, cliModule);
+    return cliModule;
+  } else {
+    debug(`CLI module '%s' is not found in dependencies`, cliPkg);
   }
 }
 
@@ -77,7 +125,7 @@ function resolveCLI(cli) {
  * to true, the command itself will be returned without running it
  */
 function runCLI(cli, args, options) {
-  cli = resolveCLI(cli);
+  cli = resolveCLI(cli, options && options.resolveFromProjectFirst);
   args = [cli].concat(args);
   debug('%s', args.join(' '));
   // Keep it backward compatible as dryRun
@@ -196,3 +244,5 @@ exports.runCLI = runCLI;
 exports.runShell = runShell;
 exports.isOptionSet = isOptionSet;
 exports.mochaConfiguredForProject = mochaConfiguredForProject;
+exports.resolveCLIFromProject = resolveCLIFromProject;
+exports.getPackageName = getPackageName;

package/package.json

@@ -6,7 +6,7 @@
 		"url": "https://github.com/strongloop/loopback-next.git",
 		"directory": "packages/build"
 	},
-	"version": "2.0.16",
+	"version": "2.1.0",
 	"engines": {
 		"node": ">=8.9"
 	},
@@ -15,17 +15,17 @@
 	"copyright.owner": "IBM Corp.",
 	"license": "MIT",
 	"dependencies": {
-		"@loopback/eslint-config": "^4.1.4",
+		"@loopback/eslint-config": "^4.1.5",
 		"@types/mocha": "^5.2.7",
 		"@types/node": "^10.17.5",
-		"@typescript-eslint/eslint-plugin": "^2.7.0",
-		"@typescript-eslint/parser": "^2.7.0",
+		"@typescript-eslint/eslint-plugin": "^2.9.0",
+		"@typescript-eslint/parser": "^2.9.0",
 		"cross-spawn": "^7.0.1",
 		"debug": "^4.1.1",
-		"eslint": "^6.6.0",
-		"eslint-config-prettier": "^6.5.0",
+		"eslint": "^6.7.1",
+		"eslint-config-prettier": "^6.7.0",
 		"eslint-plugin-eslint-plugin": "^2.1.0",
-		"eslint-plugin-mocha": "^6.2.1",
+		"eslint-plugin-mocha": "^6.2.2",
 		"fs-extra": "^8.1.0",
 		"glob": "^7.1.6",
 		"mocha": "^6.2.2",
@@ -45,7 +45,7 @@
 	},
 	"scripts": {
 		"test": "npm run mocha",
-		"mocha": "node bin/run-mocha --timeout 30000 \"test/integration/*.js\""
+		"mocha": "node bin/run-mocha --timeout 30000 \"test/integration/*.js\" \"test/unit/*.js\""
 	},
-	"gitHead": "7f0ae6ec124c19357c3016cd11f9bc9c739dffcb"
+	"gitHead": "c111543a6139c5a2999930c593aabbbdf10a838e"
 }

package/test/integration/fixtures/package.json

@@ -5,6 +5,9 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "dependencies": {
+    "typescript": "*"
+  },
   "author": "IBM Corp.",
   "license": "MIT"
 }

package/test/integration/scripts.integration.js

@@ -8,6 +8,7 @@
 const assert = require('assert');
 const path = require('path');
 const fs = require('fs-extra');
+const utils = require('../../bin/utils');
 
 describe('build', function() {
   // eslint-disable-next-line no-invalid-this
@@ -194,6 +195,24 @@ describe('build', function() {
 
     after(() => delete process.env.LERNA_ROOT_PATH);
   });
+
+  describe('resolveCLIFromProject()', () => {
+    it('returns undefined if the CLI is not found in project deps', () => {
+      assert.equal(
+        utils.resolveCLIFromProject('mocha/bin/mocha', projectDir),
+        undefined,
+      );
+    });
+
+    it('throws error if the CLI cannot be resolved', () => {
+      try {
+        utils.resolveCLIFromProject('typescript/bin/tsc', projectDir);
+        assert.fail('typescript/bin/tsc should not be resolved');
+      } catch (err) {
+        assert(err.message.match(/Cannot find module/));
+      }
+    });
+  });
 });
 
 describe('mocha', function() {

package/test/unit/utils.unit.js

@@ -0,0 +1,24 @@
+// Copyright IBM Corp. 2018. All Rights Reserved.
+// Node module: @loopback/build
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict';
+
+const assert = require('assert');
+const utils = require('../../bin/utils');
+
+describe('Build utils', () => {
+  describe('getPackageName()', () => {
+    it('supports simple packages', () => {
+      assert.equal(utils.getPackageName('typescript/bin/tsc'), 'typescript');
+    });
+
+    it('supports scoped packages', () => {
+      assert.equal(
+        utils.getPackageName('@loopback/cli/bin/cli-main'),
+        '@loopback/cli',
+      );
+    });
+  });
+});