Adjust UI for outdated cmd

Author: bdukes

.eslintrc.js

@@ -49,7 +49,7 @@ module.exports = {
 		'func-call-spacing': 'error',
 		'func-name-matching': 'error',
 		'func-names': 'error',
-		'func-style': 'error',
+		'func-style': 'off',
 		'function-paren-newline': 'off',
 		'generator-star-spacing': 'error',
 		'getter-return': 'error',

gulpfile.js

@@ -7,7 +7,11 @@ const glob = require('glob');
 const ejs = require('gulp-ejs');
 const zip = require('gulp-zip');
 const mergeStream = require('merge-stream');
-const { formatVersionFolder, compareStrings } = require('./utility');
+const {
+	formatVersionFolder,
+	compareStrings,
+	formatPackageUpgrades,
+} = require('./utility');
 
 const { dependencies } = require('./package.json');
 
@@ -57,7 +61,6 @@ gulp.task('default', libraryTaskNames);
 gulp.task('outdated', () => {
 	const packageJson = require('package-json');
 	const semver = require('semver');
-	const cliui = require('cliui');
 
 	const allUpgradesPromises = Object.keys(dependencies).map(name => {
 		const currentVersion = dependencies[name];
@@ -79,11 +82,12 @@ gulp.task('outdated', () => {
 
 		return packageUpgrades.then(upgrades => ({
 			name,
+			version: currentVersion,
 			upgrades,
 		}));
 	});
 
-	Promise.all(allUpgradesPromises).then(allUpgrades => {
+	return Promise.all(allUpgradesPromises).then(allUpgrades => {
 		const validUpgrades = allUpgrades
 			.filter(({ upgrades }) => upgrades.size > 0)
 			.sort(({ name: a }, { name: b }) => compareStrings(a, b));
@@ -94,55 +98,7 @@ gulp.task('outdated', () => {
 			return;
 		}
 
-		const ui = cliui();
-		ui.div(
-			{
-				text: 'Name',
-				align: 'left',
-				border: true,
-			},
-			{
-				text: 'Patch',
-				align: 'right',
-				border: true,
-			},
-			{
-				text: 'Minor',
-				align: 'right',
-				border: true,
-			},
-			{
-				text: 'Major',
-				align: 'right',
-				border: true,
-			}
-		);
-		validUpgrades.forEach(({ name, upgrades }) =>
-			ui.div(
-				{
-					text: name,
-					align: 'left',
-					padding: [0, 0, 0, 1],
-				},
-				{
-					text: upgrades.get('patch') || '',
-					align: 'right',
-					padding: [0, 1, 0, 0],
-				},
-				{
-					text: upgrades.get('minor') || '',
-					align: 'right',
-					padding: [0, 1, 0, 0],
-				},
-				{
-					text: upgrades.get('major') || '',
-					align: 'right',
-					padding: [0, 1, 0, 0],
-				}
-			)
-		);
-
 		log.info(`
-${ui.toString()}`);
+${formatPackageUpgrades(validUpgrades)}`);
 	});
 });

utility.js

@@ -0,0 +1,45 @@
+'use strict';
+
+const { formatPackageUpgrades } = require('./ui');
+
+/**
+ * Format a version number in the format used by DNN JS library folders
+ *
+ * @param {string} version - the version number
+ * @returns {string} the version number in the correct format
+ */
+function formatVersionFolder(version) {
+	const versionFolderPadding = 2;
+
+	return version
+		.split('.')
+		.map(n => n.padStart(versionFolderPadding, '0'))
+		.join('_');
+}
+
+/**
+ * Compares two strings, case-insensitively, for use in Array.sort
+ *
+ * @param {string|undefined} a - One string value
+ * @param {string|undefined} b - The other string value
+ * @returns {-1|0|1} The comparison value (-1 if a is less than b, 1 if a is greater than b, 0 if they're equal)
+ */
+function compareStrings(a, b) {
+	const upperA = a ? a.toUpperCase() : a;
+	const upperB = b ? b.toUpperCase() : b;
+	if (upperA < upperB) {
+		return -1;
+	}
+
+	if (upperA > upperB) {
+		return 1;
+	}
+
+	return 0;
+}
+
+module.exports = {
+	formatVersionFolder,
+	compareStrings,
+	formatPackageUpgrades,
+};

utility/index.js

@@ -0,0 +1,84 @@
+'use strict';
+
+const versionColumnWidth = 12;
+
+/**
+ * Create a CLIUI column to display a version number
+ * @private
+ * @param {string} text - The header text
+ * @returns {object} A CLIUI column
+ */
+function createVersionHeaderColumn(text) {
+	return {
+		text,
+		align: 'right',
+		border: true,
+		width: versionColumnWidth,
+	};
+}
+
+/**
+ * Create a CLIUI column to display a version number
+ * @private
+ * @param {string|undefined} version - The version number, if one exists
+ * @returns {object} A CLIUI column
+ */
+function createVersionColumn(version) {
+	return {
+		text: version || 'n/a',
+		align: 'right',
+		padding: [0, 1, 0, 0],
+		width: versionColumnWidth,
+	};
+}
+
+/**
+ * Generates a table to be displayed via the CLI which lists the version
+ * upgrades available for the packages
+ *
+ * @param {object[]} packages - The package name, current version, and a Map of
+ * available upgrade versions
+ * @returns {string} A CLI UI string
+ */
+function formatPackageUpgrades(packages) {
+	const maxNameLength = packages.reduce(
+		(max, { name }) => Math.max(max, name.length),
+		0
+	);
+	const nameColumnWidth = 1 + maxNameLength + 1;
+
+	const ui = require('cliui')();
+	ui.div(
+		{
+			text: 'Name',
+			align: 'left',
+			border: true,
+			width: nameColumnWidth,
+		},
+		createVersionHeaderColumn('Current'),
+		createVersionHeaderColumn('Patch'),
+		createVersionHeaderColumn('Minor'),
+		createVersionHeaderColumn('Major')
+	);
+
+	packages.forEach(({ name, version, upgrades }) =>
+		ui.div(
+			{
+				text: name,
+				align: 'left',
+				padding: [0, 0, 0, 1],
+				width: nameColumnWidth,
+			},
+			createVersionColumn(version),
+			createVersionColumn(upgrades.get('patch')),
+			createVersionColumn(upgrades.get('minor')),
+			createVersionColumn(upgrades.get('major'))
+		)
+	);
+
+	return ui.toString();
+}
+
+module.exports = {
+	formatPackageUpgrades,
+};