@oclif/core 2.0.2-beta.5 → 2.0.2-beta.7

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,

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/help/util.d.ts

@@ -1,11 +1,10 @@
-import * as ejs from 'ejs';
 import { Config as IConfig, HelpOptions, Deprecation } from '../interfaces';
 import { HelpBase } from '.';
 interface HelpBaseDerived {
     new (config: IConfig, opts?: Partial<HelpOptions>): HelpBase;
 }
 export declare function loadHelpClass(config: IConfig): Promise<HelpBaseDerived>;
-export declare function template(context: ejs.Data): (t: string) => string;
+export declare function template(context: any): (t: string) => string;
 export declare function toStandardizedId(commandID: string, config: IConfig): string;
 export declare function toConfiguredId(commandID: string, config: IConfig): string;
 export declare function standardizeIDFromArgv(argv: string[], config: IConfig): string[];

package/lib/help/util.js

@@ -23,6 +23,7 @@ async function loadHelpClass(config) {
     return _1.Help;
 }
 exports.loadHelpClass = loadHelpClass;
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 function template(context) {
     function render(t) {
         return ejs.render(t, context);

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,10 +1,11 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "2.0.2-beta.5",
+  "version": "2.0.2-beta.7",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
+    "@types/cli-progress": "^3.11.0",
     "ansi-escapes": "^4.3.2",
     "ansi-styles": "^4.3.0",
     "cardinal": "^2.1.1",
@@ -42,7 +43,6 @@
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/clean-stack": "^2.1.1",
-    "@types/cli-progress": "^3.11.0",
     "@types/ejs": "^3.1.0",
     "@types/fs-extra": "^9.0.13",
     "@types/indent-string": "^4.0.1",
@@ -109,7 +109,7 @@
     "lint": "eslint . --ext .ts --config .eslintrc",
     "posttest": "yarn lint",
     "prepack": "yarn run build",
-    "test": "mocha \"test/**/*.test.ts\"",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "test:e2e": "mocha \"test/**/*.e2e.ts\" --timeout 1200000",
     "pretest": "yarn build --noEmit && tsc -p test --noEmit --skipLibCheck"
   },