Merge pull request #87 from sparksuite/new-version-warning

New version warning

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 .nyc_output
 coverage
+app-versions/

package.json

@@ -1,6 +1,6 @@
 {
   "name": "waterfall-cli",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Effortlessly create CLIs powered by Node.js",
   "main": "src/index.js",
   "files": [
@@ -27,7 +27,9 @@
   "dependencies": {
     "cli-table": "^0.3.1",
     "colors": "^1.3.3",
-    "fuse.js": "^3.4.3"
+    "deepmerge": "^3.2.0",
+    "fuse.js": "^3.4.3",
+    "semver": "^6.0.0"
   },
   "devDependencies": {
     "eslint": "^5.15.1",

src/default-settings.js

@@ -7,10 +7,15 @@ const utils = require('./utils.js');
 module.exports = {
 	app: {
 		name: null,
+		packageName: null,
 		version: null,
 	},
 	arguments: utils({}).processArguments(process.argv),
 	mainFilename: require.main.filename,
+	newVersionWarning: {
+		enabled: true,
+		installedGlobally: true,
+	},
 	onStart: null,
 	packageFilePath: '../package.json',
 	spacing: {

src/index.js

@@ -3,6 +3,8 @@ require('colors');
 const { spawn } = require('child_process');
 const fs = require('fs');
 const path = require('path');
+const semver = require('semver');
+const deepmerge = require('deepmerge');
 const defaultSettings = require('./default-settings.js');
 const ErrorWithoutStack = require('./error-without-stack.js');
 const screens = require('./screens.js');
@@ -19,8 +21,7 @@ process.on('uncaughtException', (error) => {
 // The constructor, for use at the entry point
 module.exports = function Constructor(customSettings) {
 	// Merge custom settings into default settings
-	const settings = Object.assign({}, defaultSettings);
-	Object.assign(settings, customSettings);
+	const settings = deepmerge(defaultSettings, customSettings);
 
 
 	// Add spacing before
@@ -72,6 +73,54 @@ module.exports = function Constructor(customSettings) {
 	}
 
 
+	// Handle new version warning
+	if (settings.newVersionWarning.enabled && settings.app.packageName) {
+		// Determine where to store the version
+		const pathToLatestVersion = path.join(__dirname, `../app-versions/${settings.app.packageName.replace(/[^a-zA-Z0-9-.]/g, '=')}`);
+
+
+		// Make the directory
+		const appVersionsDirectory = path.dirname(pathToLatestVersion);
+
+		if (!fs.existsSync(appVersionsDirectory)) {
+			fs.mkdirSync(appVersionsDirectory);
+			utils(settings).verboseLog(`Created directory: ${appVersionsDirectory}`);
+		}
+
+
+		// Warning message
+		if (fs.existsSync(pathToLatestVersion)) {
+			// Get values
+			const latestVersion = semver.clean(`${fs.readFileSync(pathToLatestVersion)}`);
+			const currentVersion = semver.clean(settings.app.version);
+			const bothVersionsAreValid = semver.valid(latestVersion) && semver.valid(currentVersion);
+
+
+			// Verbose ouput
+			utils(settings).verboseLog(`Previously retrieved latest app version: ${latestVersion}`);
+			utils(settings).verboseLog(`Cleaned-up current app version: ${currentVersion}`);
+			utils(settings).verboseLog(`Both versions are valid: ${bothVersionsAreValid ? 'yes' : 'no'}`);
+
+
+			// Determine if warning is needed
+			if (bothVersionsAreValid && semver.gt(latestVersion, currentVersion)) {
+				console.log((`You're using an outdated version of ${settings.app.name} (${currentVersion}). The latest version is ${latestVersion.bold}`).yellow);
+				console.log(`${(`  > Upgrade by running: ${(`npm install ${settings.newVersionWarning.installedGlobally ? '--global ' : ''}${settings.app.packageName}@${latestVersion}`).bold}`).yellow}\n`);
+			}
+		}
+
+
+		// Check asynchronously if there's a new published version
+		const versionCheck = spawn('npm', ['view', settings.app.packageName, 'version']);
+
+		versionCheck.stdout.on('data', (stdout) => {
+			fs.writeFile(pathToLatestVersion, semver.clean(`${stdout}`), 'utf8', () => {
+				// Do nothing
+			});
+		});
+	}
+
+
 	// Form execution paths
 	const executionPaths = [];
 	let currentPathPrefix = path.dirname(settings.mainFilename);

src/utils.js

@@ -63,6 +63,7 @@ module.exports = function Constructor(currentSettings) {
 
 				// Store information
 				app.name = app.name || packageInfo.name;
+				app.packageName = packageInfo.name;
 				app.version = app.version || packageInfo.version;
 			} else {
 				module.exports(settings).verboseLog(`Could not find package.json at: ${pathToPackageFile}`);

test/utils.js

@@ -68,6 +68,7 @@ describe('Utils', () => {
 
 			assert.deepEqual(utils(settings).retrieveAppInformation(), {
 				name: 'pizza-ordering',
+				packageName: 'pizza-ordering',
 				version: '1.2.3',
 			});
 		});
@@ -80,6 +81,7 @@ describe('Utils', () => {
 
 			assert.deepEqual(utils(settings).retrieveAppInformation(), {
 				name: null,
+				packageName: null,
 				version: null,
 			});
 		});