@oclif/core 2.0.2-beta.6 → 2.0.2-beta.8

package/lib/config/config.js

@@ -698,12 +698,8 @@ async function toCached(c, plugin) {
             }
         }
     }
-    // v1 commands have args as an array, so we need to normalize it to an object for backwards compatibility
-    const normalized = (Array.isArray(c.args) ? (c.args ?? []).reduce((x, y) => {
-        return { ...x, [y.name]: y };
-    }, {}) : c.args ?? {});
     const args = {};
-    for (const [name, arg] of Object.entries(normalized)) {
+    for (const [name, arg] of Object.entries((0, util_3.ensureArgObject)(c.args))) {
         args[name] = {
             name,
             description: arg.description,
@@ -731,7 +727,8 @@ async function toCached(c, plugin) {
         flags,
         args,
     };
-    const ignoreCommandProperties = ['plugin', '_flags', '_enableJsonFlag', '_baseFlags'];
+    // do not include these properties in manifest
+    const ignoreCommandProperties = ['plugin', '_flags', '_enableJsonFlag', '_globalFlags', '_baseFlags'];
     const stdKeys = Object.keys(stdProperties);
     const keysToAdd = Object.keys(c).filter(property => ![...stdKeys, ...ignoreCommandProperties].includes(property));
     const additionalProperties = {};

package/lib/help/command.js

@@ -31,7 +31,7 @@ class CommandHelp extends formatter_1.HelpFormatter {
             v.name = k;
             return v;
         }), f => [!f.char, f.char, f.name]);
-        const args = Object.values(cmd.args ?? {}).filter(a => !a.hidden);
+        const args = Object.values((0, util_1.ensureArgObject)(cmd.args)).filter(a => !a.hidden);
         const output = (0, util_1.compact)(this.sections().map(({ header, generate }) => {
             const body = generate({ cmd, flags, args }, header);
             // Generate can return a list of sections

package/lib/help/docopts.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocOpts = void 0;
+const util_1 = require("../util");
 /**
  * DocOpts - See http://docopt.org/.
  *
@@ -75,7 +76,7 @@ class DocOpts {
     toString() {
         const opts = this.cmd.id === '.' || this.cmd.id === '' ? [] : ['<%= command.id %>'];
         if (this.cmd.args) {
-            const a = Object.values(this.cmd.args ?? {}).map(arg => `[${arg.name.toUpperCase()}]`) || [];
+            const a = Object.values((0, util_1.ensureArgObject)(this.cmd.args)).map(arg => `[${arg.name.toUpperCase()}]`) || [];
             opts.push(...a);
         }
         try {

package/lib/interfaces/parser.d.ts

@@ -73,7 +73,7 @@ export type Relationship = {
 export type Deprecation = {
     to?: string;
     message?: string;
-    version?: string;
+    version?: string | number;
 };
 export type FlagProps = {
     name: string;

package/lib/main.js

@@ -72,7 +72,7 @@ async function run(argv, options) {
     // command id.
     if (config.pjson.oclif.default === '.' && id === '.' && argv[0] === '.')
         argvSlice = ['.', ...argvSlice];
-    await config.runCommand(id, argvSlice, cmd);
+    return config.runCommand(id, argvSlice, cmd);
 }
 exports.run = run;
 function getTsConfigPath(dir, type) {

package/lib/util.d.ts

@@ -1,3 +1,5 @@
+import { Command } from './command';
+import { ArgInput } from './interfaces/parser';
 export declare function pickBy<T extends {
     [s: string]: T[keyof T];
 } | ArrayLike<T[keyof T]>>(obj: T, fn: (i: T[keyof T]) => boolean): Partial<T>;
@@ -15,4 +17,14 @@ export declare const fileExists: (input: string) => Promise<string>;
 export declare function isTruthy(input: string): boolean;
 export declare function isNotFalsy(input: string): boolean;
 export declare function requireJson<T>(...pathParts: string[]): T;
+/**
+ * Ensure that the provided args are an object. This is for backwards compatibility with v1 commands which
+ * defined args as an array.
+ *
+ * @param args Either an array of args or an object of args
+ * @returns ArgInput
+ */
+export declare function ensureArgObject(args?: any[] | ArgInput | {
+    [name: string]: Command.Arg.Cached;
+}): ArgInput;
 export {};

package/lib/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.requireJson = exports.isNotFalsy = exports.isTruthy = exports.fileExists = exports.dirExists = exports.capitalize = exports.sumBy = exports.maxBy = exports.isProd = exports.castArray = exports.sortBy = exports.uniqBy = exports.compact = exports.pickBy = void 0;
+exports.ensureArgObject = exports.requireJson = exports.isNotFalsy = exports.isTruthy = exports.fileExists = exports.dirExists = exports.capitalize = exports.sumBy = exports.maxBy = exports.isProd = exports.castArray = exports.sortBy = exports.uniqBy = exports.compact = exports.pickBy = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 function pickBy(obj, fn) {
@@ -105,3 +105,16 @@ function requireJson(...pathParts) {
     return JSON.parse(fs.readFileSync((0, path_1.join)(...pathParts), 'utf8'));
 }
 exports.requireJson = requireJson;
+/**
+ * Ensure that the provided args are an object. This is for backwards compatibility with v1 commands which
+ * defined args as an array.
+ *
+ * @param args Either an array of args or an object of args
+ * @returns ArgInput
+ */
+function ensureArgObject(args) {
+    return (Array.isArray(args) ? (args ?? []).reduce((x, y) => {
+        return { ...x, [y.name]: y };
+    }, {}) : args ?? {});
+}
+exports.ensureArgObject = ensureArgObject;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "2.0.2-beta.6",
+  "version": "2.0.2-beta.8",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -38,7 +38,7 @@
     "@commitlint/config-conventional": "^12.1.4",
     "@oclif/plugin-help": "^5.1.22",
     "@oclif/plugin-plugins": "^2.1.12",
-    "@oclif/test": "^2.2.19",
+    "@oclif/test": "^2.2.20",
     "@types/ansi-styles": "^3.2.1",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
@@ -68,7 +68,7 @@
     "globby": "^11.1.0",
     "husky": "6",
     "mocha": "^8.4.0",
-    "nock": "^13.2.4",
+    "nock": "^13.3.0",
     "proxyquire": "^2.1.3",
     "shelljs": "^0.8.5",
     "shx": "^0.3.4",