@oclif/core 1.24.1 → 1.24.3

package/lib/config/config.js

@@ -677,9 +677,7 @@ async function toCached(c, plugin) {
             }
         }
     }
-    // v2 commands have args as an object, so we need to normalize it to an array for forwards compatibility
-    const normalized = (Array.isArray(c.args) ? c.args ?? [] : Object.values(c.args ?? {}));
-    const argsPromise = normalized.map(async (a) => ({
+    const argsPromise = (0, util_3.ensureArgArray)(c.args).map(async (a) => ({
         name: a.name,
         description: a.description,
         required: a.required,
@@ -707,7 +705,7 @@ async function toCached(c, plugin) {
         args,
     };
     // do not include these properties in manifest
-    const ignoreCommandProperties = ['plugin', '_flags', '_enableJsonFlag', '_globalFlags'];
+    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 = (cmd.args || []).filter(a => !a.hidden);
+        const args = (0, util_1.ensureArgArray)(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 = this.cmd.args?.map(arg => `[${arg.name.toUpperCase()}]`) || [];
+            const a = (0, util_1.ensureArgArray)(this.cmd.args).map(arg => `[${arg.name.toUpperCase()}]`) || [];
             opts.push(...a);
         }
         try {

package/lib/main.js

@@ -71,6 +71,6 @@ async function run(argv = process.argv.slice(2), 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;

package/lib/util.d.ts

@@ -1,3 +1,4 @@
+import { ArgInput } from './interfaces';
 export declare function compact<T>(a: (T | undefined)[]): T[];
 export declare function uniqBy<T>(arr: T[], fn: (cur: T) => any): T[];
 type SortTypes = string | number | undefined | boolean;
@@ -7,4 +8,14 @@ export declare function isProd(): boolean;
 export declare function maxBy<T>(arr: T[], fn: (i: T) => number): T | undefined;
 export declare function sumBy<T>(arr: T[], fn: (i: T) => number): number;
 export declare function capitalize(s: string): string;
+/**
+ * Ensure that the args are in an array instead of an object. This is required to ensure
+ * forwards compatibility with the new arg format in v2.
+ *
+ * @param args The args to ensure are in an array
+ * @returns ArgInput
+ */
+export declare function ensureArgArray(args?: ArgInput | {
+    [name: string]: any;
+}): ArgInput;
 export {};

package/lib/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capitalize = exports.sumBy = exports.maxBy = exports.isProd = exports.castArray = exports.sortBy = exports.uniqBy = exports.compact = void 0;
+exports.ensureArgArray = exports.capitalize = exports.sumBy = exports.maxBy = exports.isProd = exports.castArray = exports.sortBy = exports.uniqBy = exports.compact = void 0;
 function compact(a) {
     return a.filter((a) => Boolean(a));
 }
@@ -62,3 +62,14 @@ function capitalize(s) {
     return s ? s.charAt(0).toUpperCase() + s.slice(1).toLowerCase() : '';
 }
 exports.capitalize = capitalize;
+/**
+ * Ensure that the args are in an array instead of an object. This is required to ensure
+ * forwards compatibility with the new arg format in v2.
+ *
+ * @param args The args to ensure are in an array
+ * @returns ArgInput
+ */
+function ensureArgArray(args) {
+    return Array.isArray(args) ? args ?? [] : Object.entries(args ?? {}).map(([name, arg]) => ({ ...arg, name }));
+}
+exports.ensureArgArray = ensureArgArray;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "1.24.1",
+  "version": "1.24.3",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {