util-context-installer: filter by package (#86)

* add option to filter by package name

* add option to filter by package name

* util-context-installer v0.3.0

Author: alexkilgour

packages/util-context-installer/HISTORY.md

@@ -1,5 +1,8 @@
 # History
 
+## 0.3.0 (2022-04-07)
+    * FEATURE: Add option to filter by specific package
+
 ## 0.2.0 (2022-04-06)
     * Change bin command
     * Reorder CLI messaging

packages/util-context-installer/__mocks__/globby.js

@@ -7,8 +7,8 @@
 const results = [
 	'toolkits/toolkit1/packages/package-a/package.json',
 	'toolkits/toolkit1/packages/package-b/package.json',
-	'toolkits/toolkit2/packages/package-a/package.json',
-	'toolkits/toolkit3/packages/package-a/package.json'
+	'toolkits/toolkit2/packages/package-c/package.json',
+	'toolkits/toolkit3/packages/package-d/package.json'
 ];
 
 async function globby(globPath) {
@@ -18,6 +18,12 @@ async function globby(globPath) {
 	if (globPath.includes('path/to/fail/package/')) {
 		return ['path/to/fail/package/package.json'];
 	}
+	if (globPath.includes('**/package-a')) {
+		return ['toolkits/toolkit1/packages/package-a/package.json'];
+	}
+	if (globPath.includes('nothing/here/')) {
+		return [];
+	}
 	return results;
 }
 

packages/util-context-installer/__mocks__/read-pkg.js

@@ -4,7 +4,7 @@
  */
 'use strict';
 
-module.exports = async function (obj) {
+async function readPkg(obj) {
 	if (obj.cwd.includes('toolkits/toolkit1/packages/package-a')) {
 		return {name: 'package-a', brandContext: '^1.0.0'};
 	}
@@ -13,17 +13,19 @@ module.exports = async function (obj) {
 		return {name: 'package-b', brandContext: '^2.5.0'};
 	}
 
-	if (obj.cwd.includes('toolkits/toolkit2/packages/package-a')) {
-		return {name: 'package-a', brandContext: '^1.6.2'};
+	if (obj.cwd.includes('toolkits/toolkit2/packages/package-c')) {
+		return {name: 'package-c', brandContext: '^1.6.2'};
 	}
 
-	if (obj.cwd.includes('toolkits/toolkit3/packages/package-a')) {
-		return {name: 'package-a'};
+	if (obj.cwd.includes('toolkits/toolkit3/packages/package-d')) {
+		return {name: 'package-d'};
 	}
 
 	if (obj.cwd.includes('path/to/fail/package')) {
 		return {name: 'package', brandContext: 'not.valid.semver'};
 	}
 
 	throw new Error('error');
-};
+}
+
+module.exports = jest.fn(readPkg);

packages/util-context-installer/__tests__/unit/lib/js/installer.js

@@ -7,6 +7,8 @@ const npmInstall = require('@springernature/util-package-installer');
 const reporter = require('@springernature/util-cli-reporter');
 const install = require('../../../../lib/js/installer');
 
+const readPkgMock = require('../../../../__mocks__/read-pkg');
+
 console.log = jest.fn(); // silence log output from module under test
 
 describe('util-package-installer', () => {
@@ -29,33 +31,57 @@ describe('util-package-installer', () => {
 		dependenciesObjectSpy.mockRestore();
 		cliReporterSpyWarning.mockRestore();
 		cliReporterSpyFail.mockRestore();
+		readPkgMock.mockClear();
 	});
 
 	test('calls npmInstall.dependencies for each package found', async () => {
-		expect.assertions(2);
+		expect.assertions(5);
 		await expect(
 			install()
 		).resolves.toEqual();
 		expect(dependenciesObjectSpy).toHaveBeenCalledTimes(3);
+		expect(readPkgMock).toHaveBeenNthCalledWith(1, {"cwd": path.resolve("toolkits/toolkit1/packages/package-a")})
+		expect(readPkgMock).toHaveBeenNthCalledWith(2, {"cwd": path.resolve("toolkits/toolkit1/packages/package-b")})
+		expect(readPkgMock).toHaveBeenNthCalledWith(3, {"cwd": path.resolve("toolkits/toolkit2/packages/package-c")});
 	});
 
-	test('calls npmInstall.dependencies for each package found: error reading package.json', async () => {
+	test('calls npmInstall.dependencies for each package found: filter by package name', async () => {
 		expect.assertions(3);
+		await expect(
+			install(undefined, undefined, 'package-a')
+		).resolves.toEqual();
+		expect(dependenciesObjectSpy).toHaveBeenCalledTimes(1);
+		expect(readPkgMock).toHaveBeenNthCalledWith(1, {"cwd": path.resolve("toolkits/toolkit1/packages/package-a")});
+	});
+
+	test('calls npmInstall.dependencies for each package found: error reading package.json', async () => {
+		expect.assertions(4);
 		await expect(
 			install('path/to/error/package/')
 		).resolves.toEqual();
 		expect(dependenciesObjectSpy).toHaveBeenCalledTimes(0);
 		expect(cliReporterSpyWarning).toHaveBeenCalledTimes(1);
+		expect(readPkgMock).toHaveBeenNthCalledWith(1, {"cwd": path.resolve("path/to/error/package/")})
 	});
 
 	test('calls npmInstall.dependencies for each package found: error installing brand context', async () => {
-		expect.assertions(3);
+		expect.assertions(4);
 
 		await expect(
 			install('path/to/fail/package/')
 		).rejects.toThrow();
 
 		expect(dependenciesObjectSpy).toHaveBeenCalledTimes(1);
 		expect(cliReporterSpyFail).toHaveBeenCalledTimes(1);
+		expect(readPkgMock).toHaveBeenNthCalledWith(1, {"cwd": path.resolve("path/to/fail/package/")})
+	});
+
+	test('does not call npmInstall.dependencies when no packages found', async () => {
+		expect.assertions(3);
+		await expect(
+			install('nothing/here/')
+		).resolves.toEqual();
+		expect(dependenciesObjectSpy).toHaveBeenCalledTimes(0);
+		expect(readPkgMock).toHaveBeenCalledTimes(0);
 	});
 });

packages/util-context-installer/bin/index.js

@@ -3,7 +3,7 @@
 
 const argv = require('yargs')
 	.usage('Usage: $0 [options]')
-	.example('$0 -p __dirname -c @springernature/brand-context', 'Install brand context inside packages')
+	.example('$0 -p __dirname -c @springernature/brand-context -n name-of-package', 'Install brand context inside packages')
 	.alias('p', 'path')
 	.nargs('p', 1)
 	.describe('p', 'Install path. Start crawling from here')
@@ -12,6 +12,9 @@ const argv = require('yargs')
 	.nargs('c', 1)
 	.describe('c', 'Name of the brand context')
 	.default('c', '@springernature/brand-context')
+	.alias('n', 'name')
+	.nargs('n', 1)
+	.describe('n', 'Filter by a specific package')
 	.help('h')
 	.alias('h', 'help')
 	.argv;
@@ -22,7 +25,8 @@ const install = require('../lib/js/installer');
 	try {
 		await install(
 			(argv && argv.path) ? argv.path : null,
-			(argv && argv.context) ? argv.context : null
+			(argv && argv.context) ? argv.context : null,
+			(argv && argv.name) ? argv.name : null
 		);
 	} catch (error) {
 		console.error(error);

packages/util-context-installer/lib/js/installer.js

@@ -60,11 +60,14 @@ const getPackageJsonInfo = async packageJsonDir => {
 
 /**
  * install brand-context dependency
- * @param {String} [installPath=__dirname] starting path for walking tree
+ * @param {String} [startingPath=__dirname] starting path for walking tree
  * @param {String} [contextName='@springernature/brand-context'] name of the brand-context package
+ * @param {String} packageName filter by particular package. Must be within startingPath directory tree
  * @return
  */
-module.exports = async (installPath = __dirname, contextName = '@springernature/brand-context') => {
+module.exports = async (startingPath = __dirname, contextName = '@springernature/brand-context', packageName) => {
+	const installPath = (packageName) ? path.join(startingPath, `/**/${packageName}/package.json`) : startingPath;
+
 	// Get list of package.json paths
 	const paths = await globby(installPath, {
 		expandDirectories: {
@@ -73,8 +76,10 @@ module.exports = async (installPath = __dirname, contextName = '@springernature/
 		gitignore: true
 	});
 
-	reporter.info('found', `${paths.length} packages`);
-	reporter.info('installing', contextName);
+	reporter.info('found', (paths.length === 0 || paths.length > 1) ? `${paths.length} packages` : path.dirname(paths[0]));
+	if (paths.length > 0) {
+		reporter.info('installing', contextName);
+	}
 
 	// Loop through all paths and install brand-context
 	await Promise.all(paths.map(async packageJsonPath => {
@@ -85,7 +90,9 @@ module.exports = async (installPath = __dirname, contextName = '@springernature/
 			await installBrandContext(packageJsonDir, contextName, packageInfo.version);
 		}
 	})).then(() => {
-		reporter.success('installation', 'complete');
+		if (paths.length > 0) {
+			reporter.success('installation', 'complete');
+		}
 	}).catch(error => {
 		throw error;
 	});

packages/util-context-installer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@springernature/util-context-installer",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Dynamically installs brand-context package to dependencies",
   "main": "./lib/js/installer.js",
   "repository": {