@oclif/plugin-version 1.0.4 → 1.1.2

package/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 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.2](https://github.com/oclif/plugin-version/compare/v1.1.1...v1.1.2) (2022-08-18)
+
+
+### Bug Fixes
+
+* bump some versions ([c2d19d6](https://github.com/oclif/plugin-version/commit/c2d19d68bbb755fd844efff3ab9edb1469cd222b))
+* export the Version command and the VersionDetail interface. Enhance the verbose details to include the shell and root path. ([fcf6aaf](https://github.com/oclif/plugin-version/commit/fcf6aafdfb7336e982d246753a0f2f72c5383629))
+* relax the unit test expecations ([a6c913b](https://github.com/oclif/plugin-version/commit/a6c913b523962b95d1b9fc121be2f2d1a575c55f))
+
+### [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)
+
+
+### Features
+
+* allow getting more info from version command ([b47a1fd](https://github.com/oclif/plugin-version/commit/b47a1fd83cc09f179e1594e94291051a043caaa8))
+
+
+### Bug Fixes
+
+* unit tests & lint ([a7037af](https://github.com/oclif/plugin-version/commit/a7037af4220d06f0f1ff63e09d837e2fe06568e5))
+
 ### [1.0.4](https://github.com/oclif/plugin-version/compare/v1.0.3...v1.0.4) (2022-01-06)
 
 

package/lib/commands/version.d.ts

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

package/lib/commands/version.js

@@ -1,9 +1,65 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
+const node_os_1 = require("node:os");
 class Version extends core_1.Command {
     async run() {
-        process.stdout.write(this.config.userAgent + '\n');
+        const { flags } = await this.parse(Version);
+        const [cliVersion, architecture, nodeVersion] = this.config.userAgent.split(' ');
+        const versionDetail = { cliVersion, architecture, nodeVersion };
+        let output = `${this.config.userAgent}`;
+        if (flags.verbose) {
+            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)()}`;
+            versionDetail.pluginVersions = pluginVersions;
+            versionDetail.osVersion = osVersion;
+            versionDetail.shell = this.config.shell;
+            versionDetail.rootPath = this.config.root;
+            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}
+
+ Shell:
+\t${versionDetail.shell}
+
+ Root Path:
+\t${versionDetail.rootPath}
+`;
+        }
+        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.',
+        description: 'Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.',
+    }),
+};

package/lib/index.d.ts

@@ -1,2 +1 @@
-declare const _default: {};
-export default _default;
+export { VersionDetail, default as VersionCommand } from './commands/version';

package/lib/index.js

@@ -1,3 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {};
+exports.VersionCommand = void 0;
+var version_1 = require("./commands/version");
+Object.defineProperty(exports, "VersionCommand", { enumerable: true, get: function () { return version_1.default; } });

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.4","commands":{"version":{"id":"version","strict":true,"pluginName":"@oclif/plugin-version","pluginAlias":"@oclif/plugin-version","pluginType":"core","aliases":[],"flags":{},"args":[]}}}
+{"version":"1.1.2","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,29 +1,30 @@
 {
   "name": "@oclif/plugin-version",
   "description": "A command that shows the CLI version",
-  "version": "1.0.4",
+  "version": "1.1.2",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-version/issues",
   "dependencies": {
-    "@oclif/core": "^1.1.1"
+    "@oclif/core": "^1.14.1"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^12.1.4",
-    "@oclif/plugin-help": "5.1.10",
-    "@oclif/test": "^2.0.3",
-    "@types/chai": "^4.3.0",
+    "@oclif/plugin-help": "5.1.12",
+    "@oclif/test": "^2.1.1",
+    "@types/chai": "^4.3.1",
     "@types/mocha": "^8.0.0",
-    "@types/node": "^14.0.26",
-    "chai": "^4.2.0",
+    "@types/node": "^14.18.23",
+    "chai": "^4.3.6",
     "commitlint": "^12.1.4",
     "eslint": "^7.3.1",
     "eslint-config-oclif": "^4",
     "eslint-config-oclif-typescript": "^1.0.2",
     "husky": "6",
     "mocha": "^8.2.1",
-    "oclif": "2.1.0",
-    "ts-node": "^10.4.0",
-    "typescript": "4.5.2"
+    "oclif": "2.7.0",
+    "shx": "^0.3.4",
+    "ts-node": "^10.9.1",
+    "typescript": "4.6.3"
   },
   "engines": {
     "node": ">=12.0.0"
@@ -46,9 +47,9 @@
   },
   "repository": "oclif/plugin-version",
   "scripts": {
-    "build": "rm -rf lib && tsc",
+    "build": "shx rm -rf lib && tsc",
     "commitlint": "commitlint",
-    "clean": "rm -f oclif.manifest.json",
+    "clean": "shx rm -f oclif.manifest.json",
     "lint": "eslint . --ext .ts --config .eslintrc",
     "pretest": "yarn build",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",