feat: add versions visual comparison

Author: oss6

README.md

@@ -128,6 +128,7 @@ Synopsis: `vf-core-service-discovery run [options]`
 | `-d`, `--disabled`             | array | `[]`                       | List of disabled steps (from getConfig, getChangelog getDependents)     |
 | `-o`, `--only-outdated` | boolean | `false` | Display only outdated components |
 | `-m`, `--format` | string | `''` | Specifies the formatting for the results |
+| `-c`, `--compare-versions` | boolean | `false` | Shows the visual difference between different component versions |
 
 #### Custom formatting
 

package.json

@@ -72,6 +72,7 @@
     "mkdirp": "^1.0.4",
     "rimraf": "^3.0.2",
     "semver": "^7.3.4",
+    "vf-core-service-discovery-versions-comparison": "^0.2.1",
     "winston": "^3.3.3",
     "yaml": "^1.10.0",
     "yargs": "^16.1.1"

src/cli/run.ts

@@ -1,15 +1,23 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
+import { promisify } from 'util';
+import path from 'path';
 import chalk from 'chalk';
 import boxen from 'boxen';
+import rimraf from 'rimraf';
+import compareVersions from 'vf-core-service-discovery-versions-comparison';
 import ServiceDiscovery from '..';
 import { Reporter } from '../types';
+import { PassThrough } from 'stream';
+
+const rimrafP = promisify(rimraf);
 
 interface Arguments {
   verbose: boolean;
   'log-file': string;
   force: boolean;
   profile: boolean;
   'only-outdated': boolean;
+  'compare-versions': boolean;
   reporters: string[];
   disabled: string[];
   format: string;
@@ -62,6 +70,12 @@ export const builder = {
     default: '',
     alias: 'm',
   },
+  'compare-versions': {
+    description: "Compare components' versions",
+    type: 'boolean',
+    default: false,
+    alias: 'c',
+  },
 };
 
 export async function handler(argv: Arguments): Promise<void> {
@@ -89,6 +103,39 @@ export async function handler(argv: Arguments): Promise<void> {
     for (const report of reporters) {
       await report(items, argv.format);
     }
+
+    const discoveryItemsForComparison = items
+      .map((item) => item.discoveryItem)
+      .filter((item) => item.version !== item.packageJson?.version);
+
+    if (argv['compare-versions'] && discoveryItemsForComparison.length > 0) {
+      const temporaryWebServerFilesDirectory = path.join(process.cwd(), 'vf-core-service-discovery-tmp');
+      const logStream = new PassThrough({ encoding: 'utf-8' });
+
+      logStream.on('data', (data) => {
+        console.log(data);
+      });
+
+      await compareVersions(
+        temporaryWebServerFilesDirectory,
+        {
+          components: discoveryItemsForComparison.map((item) => ({
+            name: item.name,
+            nameWithoutPrefix: item.nameWithoutPrefix,
+            installedVersion: item.version,
+            latestVersion: item.packageJson?.version,
+          })),
+        },
+        logStream,
+      );
+
+      // TODO: check windows
+      process.on('SIGINT', async () => {
+        console.log(`Deleting temporary web server files directory: ${temporaryWebServerFilesDirectory}`);
+        await rimrafP(temporaryWebServerFilesDirectory);
+        process.exit();
+      });
+    }
   } catch (error) {
     console.log(error);
     process.exit(1);