@oclif/plugin-version 2.0.18 → 2.1.0

package/README.md

@@ -27,7 +27,7 @@ FLAG DESCRIPTIONS
     Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
 ```
 
-_See code: [src/commands/version.ts](https://github.com/oclif/plugin-version/blob/v2.0.18/src/commands/version.ts)_
+_See code: [src/commands/version.ts](https://github.com/oclif/plugin-version/blob/v2.1.0/src/commands/version.ts)_
 <!-- commandsstop -->
 
 # Contributing

package/lib/commands/version.d.ts

@@ -8,6 +8,4 @@ export default class Version extends Command {
         verbose: Interfaces.BooleanFlag<boolean>;
     };
     run(): Promise<VersionDetail>;
-    private formatPlugins;
-    private getFriendlyName;
 }

package/lib/commands/version.js

@@ -1,5 +1,57 @@
 import { Command, Flags } from '@oclif/core';
+import { Ansis } from 'ansis';
+import { exec } from 'node:child_process';
 import { EOL } from 'node:os';
+const ansis = new Ansis();
+async function getNpmDetails(pkg) {
+    return new Promise((resolve) => {
+        exec(`npm view ${pkg} --json`, (error, stdout) => {
+            if (error) {
+                resolve(false);
+            }
+            else {
+                resolve(JSON.parse(stdout));
+            }
+        });
+    });
+}
+function daysAgo(date) {
+    const now = new Date();
+    const then = new Date(date);
+    const diff = now.getTime() - then.getTime();
+    return Math.floor(diff / (1000 * 60 * 60 * 24));
+}
+function humanReadableDate(date) {
+    return new Date(date).toDateString();
+}
+async function formatPlugins(config, plugins) {
+    const sorted = Object.entries(plugins)
+        .map(([name, plugin]) => ({ name, ...plugin }))
+        .sort((a, b) => (a.name > b.name ? 1 : -1));
+    return Promise.all(sorted.map(async (plugin) => {
+        const base = `${getFriendlyName(config, plugin.name)} ${ansis.dim(plugin.version)} ${ansis.dim(`(${plugin.type})`)} ${plugin.type === 'link' ? ansis.dim(plugin.root) : ''}`.trim();
+        if (plugin.type === 'user') {
+            const npmDetails = await getNpmDetails(plugin.name);
+            const publishedString = npmDetails
+                ? ansis.dim(` published ${daysAgo(npmDetails.time[plugin.version])} days ago (${humanReadableDate(npmDetails.time[plugin.version])})`)
+                : '';
+            const notLatestWarning = npmDetails && plugin.version !== npmDetails['dist-tags'].latest
+                ? ansis.red(` (latest is ${npmDetails['dist-tags'].latest})`)
+                : '';
+            return `${base}${publishedString}${notLatestWarning}`;
+        }
+        return base;
+    }));
+}
+function getFriendlyName(config, name) {
+    const { scope } = config.pjson.oclif;
+    if (!scope)
+        return name;
+    const match = name.match(`@${scope}/plugin-(.+)`);
+    if (!match)
+        return name;
+    return match[1];
+}
 export default class Version extends Command {
     static enableJsonFlag = true;
     static flags = {
@@ -14,52 +66,47 @@ export default class Version extends Command {
         const versionDetail = { ...theRest };
         let output = `${this.config.userAgent}`;
         if (flags.verbose) {
-            versionDetail.pluginVersions = this.formatPlugins(pluginVersions ?? {});
+            const details = await getNpmDetails(this.config.pjson.name);
+            const cliPublishedString = details
+                ? ansis.dim(` published ${daysAgo(details.time[details.version])} days ago (${humanReadableDate(details.time[details.version])})`)
+                : '';
+            const notLatestWarning = details && this.config.version !== details['dist-tags'].latest
+                ? ansis.red(` (latest is ${details['dist-tags'].latest})`)
+                : '';
+            versionDetail.pluginVersions = await formatPlugins(this.config, pluginVersions ?? {});
             versionDetail.shell ??= 'unknown';
-            output = ` CLI Version:
-\t${versionDetail.cliVersion}
+            output = ` ${ansis.bold('CLI Version')}:
+\t${versionDetail.cliVersion}${cliPublishedString}${notLatestWarning}
 
- Architecture:
+ ${ansis.bold('Architecture')}:
 \t${versionDetail.architecture}
 
- Node Version:
+ ${ansis.bold('Node Version')}:
 \t${versionDetail.nodeVersion}
 
- Plugin Version:
-\t${flags.verbose ? (versionDetail.pluginVersions ?? []).join(EOL + '\t') : ''}
+ ${ansis.bold('Plugin Version')}:
+\t${(versionDetail.pluginVersions ?? []).join(EOL + '\t')}
 
- OS and Version:
+ ${ansis.bold('OS and Version')}:
 \t${versionDetail.osVersion}
 
- Shell:
+ ${ansis.bold('Shell')}:
 \t${versionDetail.shell}
 
- Root Path:
+ ${ansis.bold('Root Path')}:
 \t${versionDetail.rootPath}
 `;
         }
         this.log(output);
         return flags.verbose
-            ? versionDetail
+            ? {
+                ...versionDetail,
+                pluginVersions: versionDetail.pluginVersions?.map((plugin) => ansis.strip(plugin)),
+            }
             : {
                 architecture: versionDetail.architecture,
                 cliVersion: versionDetail.cliVersion,
                 nodeVersion: versionDetail.nodeVersion,
             };
     }
-    formatPlugins(plugins) {
-        return Object.entries(plugins)
-            .map(([name, plugin]) => ({ name, ...plugin }))
-            .sort((a, b) => (a.name > b.name ? 1 : -1))
-            .map((plugin) => `${this.getFriendlyName(plugin.name)} ${plugin.version} (${plugin.type}) ${plugin.type === 'link' ? plugin.root : ''}`.trim());
-    }
-    getFriendlyName(name) {
-        const { scope } = this.config.pjson.oclif;
-        if (!scope)
-            return name;
-        const match = name.match(`@${scope}/plugin-(.+)`);
-        if (!match)
-            return name;
-        return match[1];
-    }
 }

package/oclif.manifest.json

@@ -35,5 +35,5 @@
       ]
     }
   },
-  "version": "2.0.18"
+  "version": "2.1.0"
 }

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@oclif/plugin-version",
   "description": "A command that shows the CLI version",
-  "version": "2.0.18",
+  "version": "2.1.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-version/issues",
   "dependencies": {
-    "@oclif/core": "^3.26.5"
+    "@oclif/core": "^3.26.5",
+    "ansis": "^3.2.0"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^18",
@@ -35,7 +36,6 @@
   },
   "files": [
     "oclif.manifest.json",
-    "npm-shrinkwrap.json",
     "/lib"
   ],
   "homepage": "https://github.com/oclif/plugin-version",
@@ -53,12 +53,12 @@
   "repository": "oclif/plugin-version",
   "scripts": {
     "build": "shx rm -rf lib && tsc",
-    "clean": "shx rm -f oclif.manifest.json npm-shrinkwrap.json",
+    "clean": "shx rm -f oclif.manifest.json",
     "compile": "tsc",
     "lint": "eslint . --ext .ts",
     "postpack": "yarn run clean",
     "posttest": "yarn lint",
-    "prepack": "yarn build && oclif manifest && oclif readme && npm shrinkwrap",
+    "prepack": "yarn build && oclif manifest && oclif readme",
     "prepare": "husky && yarn build",
     "pretest": "yarn build --noEmit && tsc -p test --noEmit",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",