@oclif/plugin-version 1.1.0 → 1.1.1

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.1.1](https://github.com/oclif/plugin-version/compare/v1.1.0...v1.1.1) (2022-06-27)
+
+
+### Bug Fixes
+
+* add --json flag ([47d7105](https://github.com/oclif/plugin-version/commit/47d7105a4bd36f8bed8d4772485c4f5eef0fdacd))
+* suggestions on how to improve PR [#70](https://github.com/oclif/plugin-version/issues/70) ([4023f70](https://github.com/oclif/plugin-version/commit/4023f708204ca940b905cf98e43c0fce72a97307))
+
 ## [1.1.0](https://github.com/oclif/plugin-version/compare/v1.0.4...v1.1.0) (2022-06-13)
 
 

package/lib/commands/version.d.ts

@@ -1,7 +1,17 @@
 import { Command } from '@oclif/core';
+interface VersionDetail {
+    cliVersion: string;
+    architecture: string;
+    nodeVersion: string;
+    pluginVersions?: string[];
+    osVersion?: string;
+}
 export default class Version extends Command {
+    static enableJsonFlag: boolean;
     static flags: {
         verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<void>;
+    run(): Promise<VersionDetail>;
+    private getFriendlyName;
 }
+export {};

package/lib/commands/version.js

@@ -5,28 +5,50 @@ const node_os_1 = require("node:os");
 class Version extends core_1.Command {
     async run() {
         const { flags } = await this.parse(Version);
-        let output = `${this.config.userAgent}${node_os_1.EOL}`;
+        const [cliVersion, architecture, nodeVersion] = this.config.userAgent.split(' ');
+        const versionDetail = { cliVersion, architecture, nodeVersion };
+        let output = `${this.config.userAgent}`;
         if (flags.verbose) {
-            const versions = this.config.userAgent.split(' ');
-            const cliVersion = versions[0];
-            const architecture = versions[1];
-            const nodeVersion = versions[2];
-            let pluginVersions = '';
-            for (const plugin of this.config.plugins) {
-                pluginVersions += `${node_os_1.EOL}\t${plugin.name}@${plugin.version} (${plugin.type})`;
+            const pluginVersions = [];
+            for (const plugin of this.config.plugins.sort((a, b) => a.name > b.name ? 1 : -1)) {
+                if (this.config.name !== plugin.name) {
+                    pluginVersions.push(`${this.getFriendlyName(plugin.name)} ${plugin.version} (${plugin.type}) ${plugin.type === 'link' ? plugin.root : ''}`.trim());
+                }
             }
             const osVersion = `${(0, node_os_1.type)()} ${(0, node_os_1.release)()}`;
-            output = ` CLI Version : ${node_os_1.EOL}\t${cliVersion}
-${node_os_1.EOL} Architecture: ${node_os_1.EOL}\t${architecture}
-${node_os_1.EOL} Node Version : ${node_os_1.EOL}\t${nodeVersion}
-${node_os_1.EOL} Plugin Version: ${pluginVersions}
-${node_os_1.EOL} OS and Version: ${node_os_1.EOL}\t${osVersion}
+            versionDetail.pluginVersions = pluginVersions;
+            versionDetail.osVersion = osVersion;
+            output = ` CLI Version:
+\t${cliVersion}
+
+ Architecture:
+\t${architecture}
+
+ Node Version:
+\t${nodeVersion}
+
+ Plugin Version:
+\t${pluginVersions.join(`${node_os_1.EOL}\t`)}
+
+ OS and Version:
+\t${osVersion}
 `;
         }
-        process.stdout.write(output);
+        this.log(output);
+        return versionDetail;
+    }
+    getFriendlyName(name) {
+        const scope = this.config.pjson.oclif.scope;
+        if (!scope)
+            return name;
+        const match = name.match(`@${scope}/plugin-(.+)`);
+        if (!match)
+            return name;
+        return match[1];
     }
 }
 exports.default = Version;
+Version.enableJsonFlag = true;
 Version.flags = {
     verbose: core_1.Flags.boolean({
         summary: 'Show additional information about the CLI.',

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.1.0","commands":{"version":{"id":"version","strict":true,"pluginName":"@oclif/plugin-version","pluginAlias":"@oclif/plugin-version","pluginType":"core","aliases":[],"flags":{"verbose":{"name":"verbose","type":"boolean","summary":"Show additional information about the CLI.","description":"Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.","allowNo":false}},"args":[],"_globalFlags":{}}}}
+{"version":"1.1.1","commands":{"version":{"id":"version","strict":true,"pluginName":"@oclif/plugin-version","pluginAlias":"@oclif/plugin-version","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"verbose":{"name":"verbose","type":"boolean","summary":"Show additional information about the CLI.","description":"Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.","allowNo":false}},"args":[],"enableJsonFlag":true,"_globalFlags":{"json":{"description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"type":"boolean"}}}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/plugin-version",
   "description": "A command that shows the CLI version",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-version/issues",
   "dependencies": {