@oclif/core 3.0.0-beta.17 → 3.0.0-beta.18

package/lib/cli-ux/action/base.js

@@ -5,13 +5,13 @@ const stream_1 = require("../stream");
 const util_1 = require("../../util");
 const node_util_1 = require("node:util");
 class ActionBase {
-    constructor() {
-        this.std = 'stderr';
-        this.stdmockOrigs = {
-            stdout: stream_1.stdout.write,
-            stderr: stream_1.stderr.write,
-        };
-    }
+    type;
+    std = 'stderr';
+    stdmocks;
+    stdmockOrigs = {
+        stdout: stream_1.stdout.write,
+        stderr: stream_1.stderr.write,
+    };
     start(action, status, opts = {}) {
         this.std = opts.stdout ? 'stdout' : 'stderr';
         const task = { action, status, active: Boolean(this.task && this.task.active) };

package/lib/cli-ux/action/simple.js

@@ -2,10 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("./base");
 class SimpleAction extends base_1.ActionBase {
-    constructor() {
-        super(...arguments);
-        this.type = 'simple';
-    }
+    type = 'simple';
     _start() {
         if (!this.task)
             return;

package/lib/cli-ux/action/spinner.js

@@ -15,9 +15,12 @@ function color(s) {
     return has256 ? `\u001B[38;5;104m${s}${ansi_styles_1.default.reset.open}` : chalk_1.default.magenta(s);
 }
 class SpinnerAction extends base_1.ActionBase {
+    type = 'spinner';
+    spinner;
+    frames;
+    frameIndex;
     constructor() {
         super();
-        this.type = 'spinner';
         this.frames = this.getFrames();
         this.frameIndex = 0;
     }
@@ -55,7 +58,7 @@ class SpinnerAction extends base_1.ActionBase {
     }
     getFrames(opts) {
         if (opts?.style)
-            return spinners_1.default[process.platform === 'win32' ? 'line' : opts.style].frames;
+            return spinners_1.default[opts.style].frames;
         return spinners_1.default[process.platform === 'win32' ? 'line' : 'dots2'].frames;
     }
     _render(icon) {

package/lib/cli-ux/config.js

@@ -13,12 +13,10 @@ const actionType = (Boolean(process.stderr.isTTY)
     && 'spinner') || 'simple';
 const Action = actionType === 'spinner' ? spinner_1.default : simple_1.default;
 class Config {
-    constructor() {
-        this.outputLevel = 'info';
-        this.action = new Action();
-        this.errorsHandled = false;
-        this.showStackTrace = true;
-    }
+    outputLevel = 'info';
+    action = new Action();
+    errorsHandled = false;
+    showStackTrace = true;
     get debug() {
         return globals.debug || process.env.DEBUG === '*';
     }

package/lib/cli-ux/exit.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExitError = void 0;
 class ExitError extends Error {
+    ux;
+    code;
+    error;
     constructor(status, error) {
         const code = 'EEXIT';
         super(error ? error.message : `${code}: ${status}`);

package/lib/cli-ux/flush.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.flush = void 0;
-const __1 = require("..");
+const errors_1 = require("../errors");
+const stream_1 = require("./stream");
 function timeout(p, ms) {
     function wait(ms, unref = false) {
         return new Promise(resolve => {
@@ -10,13 +11,13 @@ function timeout(p, ms) {
                 t.unref();
         });
     }
-    return Promise.race([p, wait(ms, true).then(() => __1.Errors.error('timed out'))]);
+    return Promise.race([p, wait(ms, true).then(() => (0, errors_1.error)('timed out'))]);
 }
 async function _flush() {
     const p = new Promise(resolve => {
-        __1.stdout.once('drain', () => resolve(null));
+        stream_1.stdout.once('drain', () => resolve(null));
     });
-    const flushed = __1.stdout.write('');
+    const flushed = stream_1.stdout.write('');
     if (flushed)
         return;
     return p;

package/lib/cli-ux/index.js

@@ -13,6 +13,7 @@ const node_util_1 = require("node:util");
 const wait_1 = tslib_1.__importDefault(require("./wait"));
 const hyperlinker = require('hyperlinker');
 class ux {
+    static config = config_1.config;
     static get prompt() {
         return uxPrompt.prompt;
     }
@@ -92,7 +93,6 @@ class ux {
     }
 }
 exports.ux = ux;
-ux.config = config_1.config;
 const { action, annotation, anykey, confirm, debug, done, flush, info, log, progress, prompt, styledHeader, styledJSON, styledObject, table, trace, tree, url, wait, } = ux;
 exports.action = action;
 exports.annotation = annotation;

package/lib/cli-ux/stream.js

@@ -5,6 +5,7 @@ exports.stderr = exports.stdout = void 0;
  * A wrapper around process.stdout and process.stderr that allows us to mock out the streams for testing.
  */
 class Stream {
+    channel;
     constructor(channel) {
         this.channel = channel;
     }

package/lib/cli-ux/styled/json.js

@@ -2,15 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const index_1 = require("../../index");
+const node_util_1 = require("node:util");
+const stream_1 = require("../stream");
+const info = (output) => stream_1.stdout.write((0, node_util_1.format)(output) + '\n');
 function styledJSON(obj) {
     const json = JSON.stringify(obj, null, 2);
     if (!chalk_1.default.level) {
-        index_1.ux.info(json);
+        info(json);
         return;
     }
     const cardinal = require('cardinal');
     const theme = require('cardinal/themes/jq');
-    index_1.ux.info(cardinal.highlight(json, { json: true, theme }));
+    info(cardinal.highlight(json, { json: true, theme }));
 }
 exports.default = styledJSON;

package/lib/cli-ux/styled/table.js

@@ -13,6 +13,9 @@ const stream_1 = require("../stream");
 const screen_1 = require("../../screen");
 const string_width_1 = tslib_1.__importDefault(require("string-width"));
 class Table {
+    data;
+    options;
+    columns;
     constructor(data, columns, options = {}) {
         this.data = data;
         // assign columns

package/lib/cli-ux/styled/tree.js

@@ -3,9 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tree = void 0;
 const treeify = require('object-treeify');
 class Tree {
-    constructor() {
-        this.nodes = {};
-    }
+    nodes = {};
     insert(child, value = new Tree()) {
         this.nodes[child] = value;
         return this;

package/lib/command.d.ts

@@ -65,13 +65,7 @@ export declare abstract class Command {
      */
     static examples: Command.Example[];
     static hasDynamicHelp: boolean;
-    protected static '_--': boolean;
-    protected static _enableJsonFlag: boolean;
-    static get enableJsonFlag(): boolean;
-    static set enableJsonFlag(value: boolean);
-    static get '--'(): boolean;
-    static set '--'(value: boolean);
-    get passThroughEnabled(): boolean;
+    static enableJsonFlag: boolean;
     /**
      * instantiate and run the command
      *
@@ -81,13 +75,9 @@ export declare abstract class Command {
      * @returns {Promise<unknown>} result
      */
     static run<T extends Command>(this: new (argv: string[], config: Config) => T, argv?: string[], opts?: LoadOptions): Promise<ReturnType<T['run']>>;
-    protected static _baseFlags: FlagInput;
-    static get baseFlags(): FlagInput;
-    static set baseFlags(flags: FlagInput);
+    static baseFlags: FlagInput;
     /** A hash of flags for the command */
-    protected static _flags: FlagInput;
-    static get flags(): FlagInput;
-    static set flags(flags: FlagInput);
+    static flags: FlagInput;
     id: string | undefined;
     protected debug: (...args: any[]) => void;
     constructor(argv: string[], config: Config);
@@ -164,7 +154,9 @@ export declare namespace Command {
     };
     type Flag = IFlag<any>;
     namespace Flag {
-        type Cached = Omit<Flag, 'parse' | 'input'> & (BooleanFlagProps | OptionFlagProps);
+        type Cached = Omit<Flag, 'parse' | 'input'> & (BooleanFlagProps | OptionFlagProps) & {
+            hasDynamicHelp?: boolean;
+        };
         type Any = Flag | Cached;
     }
     type Arg = IArg<any>;

package/lib/command.js

@@ -9,7 +9,7 @@ const util_1 = require("./help/util");
 const util_2 = require("./util");
 const stream_1 = require("./cli-ux/stream");
 const config_1 = require("./config");
-const flags_1 = require("./flags");
+const aggregate_flags_1 = require("./util/aggregate-flags");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const node_url_1 = require("node:url");
 const cli_ux_1 = require("./cli-ux");
@@ -23,40 +23,68 @@ stream_1.stdout.on('error', (err) => {
         return;
     throw err;
 });
-const jsonFlag = {
-    json: (0, flags_1.boolean)({
-        description: 'Format output as json.',
-        helpGroup: 'GLOBAL',
-    }),
-};
 /**
  * An abstract class which acts as the base for each command
  * in your project.
  */
 class Command {
-    static get enableJsonFlag() {
-        return this._enableJsonFlag;
-    }
-    static set enableJsonFlag(value) {
-        this._enableJsonFlag = value;
-        if (value === true) {
-            this.baseFlags = jsonFlag;
-        }
-        else {
-            delete this.baseFlags?.json;
-            this.flags = {}; // force the flags setter to run
-            delete this.flags?.json;
-        }
-    }
-    static get '--'() {
-        return Command['_--'];
-    }
-    static set '--'(value) {
-        Command['_--'] = value;
-    }
-    get passThroughEnabled() {
-        return Command['_--'];
-    }
+    argv;
+    config;
+    static _base = `${pjson.name}@${pjson.version}`;
+    /** A command ID, used mostly in error or verbose reporting. */
+    static id;
+    /**
+     * The tweet-sized description for your class, used in a parent-commands
+     * sub-command listing and as the header for the command help.
+     */
+    static summary;
+    /**
+     * A full description of how to use the command.
+     *
+     * If no summary, the first line of the description will be used as the summary.
+     */
+    static description;
+    /** Hide the command from help */
+    static hidden;
+    /** Mark the command as a given state (e.g. beta or deprecated) in help */
+    static state;
+    static deprecationOptions;
+    /**
+     * Emit deprecation warning when a command alias is used
+     */
+    static deprecateAliases;
+    /**
+     * An override string (or strings) for the default usage documentation.
+     */
+    static usage;
+    static help;
+    /** An array of aliases for this command. */
+    static aliases = [];
+    /** When set to false, allows a variable amount of arguments */
+    static strict = true;
+    /** An order-dependent object of arguments for the command */
+    static args = {};
+    static plugin;
+    static pluginName;
+    static pluginType;
+    static pluginAlias;
+    /**
+     * An array of examples to show at the end of the command's help.
+     *
+     * IF only a string is provided, it will try to look for a line that starts
+     * with the cmd.bin as the example command and the rest as the description.
+     * If found, the command will be formatted appropriately.
+     *
+     * ```
+     * EXAMPLES:
+     *   A description of a particular use case.
+     *
+     *     $ <%= config.bin => command flags
+     * ```
+     */
+    static examples;
+    static hasDynamicHelp = false;
+    static enableJsonFlag = false;
     /**
      * instantiate and run the command
      *
@@ -81,21 +109,11 @@ class Command {
         }
         return cmd._run();
     }
-    static get baseFlags() {
-        return this._baseFlags;
-    }
-    static set baseFlags(flags) {
-        // eslint-disable-next-line prefer-object-spread
-        this._baseFlags = Object.assign({}, this.baseFlags, flags);
-        this.flags = {}; // force the flags setter to run
-    }
-    static get flags() {
-        return this._flags;
-    }
-    static set flags(flags) {
-        // eslint-disable-next-line prefer-object-spread
-        this._flags = Object.assign({}, this._flags ?? {}, this.baseFlags, flags);
-    }
+    static baseFlags;
+    /** A hash of flags for the command */
+    static flags;
+    id;
+    debug;
     constructor(argv, config) {
         this.argv = argv;
         this.config = config;
@@ -161,16 +179,19 @@ class Command {
      * @returns {boolean} true if the command supports json and the --json flag is present
      */
     jsonEnabled() {
-        // if the command doesn't support json, return false
+        // If the command doesn't support json, return false
         if (!this.ctor.enableJsonFlag)
             return false;
-        // if the command parameter pass through is enabled, return true if the --json flag is before the '--' separator
-        if (this.passThroughEnabled) {
-            const ptIndex = this.argv.indexOf('--');
-            const jsonIndex = this.argv.indexOf('--json');
-            return jsonIndex > -1 && (ptIndex === -1 || jsonIndex < ptIndex);
-        }
-        return this.argv.includes('--json') || this.config.scopedEnvVar?.('CONTENT_TYPE')?.toLowerCase() === 'json';
+        // If the CONTENT_TYPE env var is set to json, return true
+        if (this.config.scopedEnvVar?.('CONTENT_TYPE')?.toLowerCase() === 'json')
+            return true;
+        const passThroughIndex = this.argv.indexOf('--');
+        const jsonIndex = this.argv.indexOf('--json');
+        return passThroughIndex === -1
+            // If '--' is not present, then check for `--json` in this.argv
+            ? jsonIndex > -1
+            // If '--' is present, return true only the --json flag exists and is before the '--'
+            : jsonIndex > -1 && jsonIndex < passThroughIndex;
     }
     async init() {
         this.debug('init version: %s argv: %o', this.ctor._base, this.argv);
@@ -184,8 +205,9 @@ class Command {
         this.warnIfCommandDeprecated();
     }
     warnIfFlagDeprecated(flags) {
+        const allFlags = (0, aggregate_flags_1.aggregateFlags)(this.ctor.flags, this.ctor.baseFlags, this.ctor.enableJsonFlag);
         for (const flag of Object.keys(flags)) {
-            const flagDef = this.ctor.flags[flag];
+            const flagDef = allFlags[flag];
             const deprecated = flagDef?.deprecated;
             if (deprecated) {
                 this.warn((0, util_1.formatFlagDeprecationWarning)(flag, deprecated));
@@ -221,10 +243,11 @@ class Command {
     async parse(options, argv = this.argv) {
         if (!options)
             options = this.ctor;
-        const opts = { context: this, ...options };
-        // the spread operator doesn't work with getters so we have to manually add it here
-        opts.flags = options?.flags;
-        opts.args = options?.args;
+        const opts = {
+            context: this,
+            ...options,
+            flags: (0, aggregate_flags_1.aggregateFlags)(options.flags, options.baseFlags, options.enableJsonFlag),
+        };
         const results = await Parser.parse(argv, opts);
         this.warnIfFlagDeprecated(results.flags ?? {});
         return results;
@@ -275,13 +298,3 @@ class Command {
     }
 }
 exports.Command = Command;
-Command._base = `${pjson.name}@${pjson.version}`;
-/** An array of aliases for this command. */
-Command.aliases = [];
-/** When set to false, allows a variable amount of arguments */
-Command.strict = true;
-/** An order-dependent object of arguments for the command */
-Command.args = {};
-Command.hasDynamicHelp = false;
-Command['_--'] = false;
-Command._enableJsonFlag = false;

package/lib/config/config.d.ts

@@ -154,4 +154,3 @@ export declare class Config implements IConfig {
       */
     private insertLegacyPlugins;
 }
-export declare function toCached(c: Command.Class, plugin?: IPlugin, respectNoCacheDefault?: boolean): Promise<Command.Cached>;