@oclif/core 3.0.0-beta.2 → 3.0.0-beta.20

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

@@ -1,17 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.table = void 0;
-const F = require("../../flags");
-const screen_1 = require("../../screen");
-const chalk = require("chalk");
-const util_1 = require("../../util");
+const tslib_1 = require("tslib");
+const F = tslib_1.__importStar(require("../../flags"));
+const util_1 = require("../../util/util");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const node_util_1 = require("node:util");
+const natural_orderby_1 = require("natural-orderby");
 const js_yaml_1 = require("js-yaml");
-const util_2 = require("util");
+const slice_ansi_1 = tslib_1.__importDefault(require("slice-ansi"));
 const stream_1 = require("../stream");
-const sw = require('string-width');
-const { orderBy } = require('natural-orderby');
-const sliceAnsi = require('slice-ansi');
+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
@@ -20,8 +24,8 @@ class Table {
             const extended = col.extended ?? false;
             // turn null and undefined into empty strings by default
             const get = col.get ?? ((row) => row[key] ?? '');
-            const header = typeof col.header === 'string' ? col.header : (0, util_1.capitalize)(key.replace(/_/g, ' '));
-            const minWidth = Math.max(col.minWidth ?? 0, sw(header) + 1);
+            const header = typeof col.header === 'string' ? col.header : (0, util_1.capitalize)(key.replaceAll('_', ' '));
+            const minWidth = Math.max(col.minWidth ?? 0, (0, string_width_1.default)(header) + 1);
             return {
                 extended,
                 get,
@@ -47,19 +51,18 @@ class Table {
     }
     display() {
         // build table rows from input array data
-        let rows = this.data.map(d => {
+        let rows = this.data.map((d) => {
             const row = {};
             for (const col of this.columns) {
                 let val = col.get(d);
                 if (typeof val !== 'string')
-                    val = (0, util_2.inspect)(val, { breakLength: Number.POSITIVE_INFINITY });
+                    val = (0, node_util_1.inspect)(val, { breakLength: Number.POSITIVE_INFINITY });
                 row[col.key] = val;
             }
             return row;
         });
         // filter rows
         if (this.options.filter) {
-            /* eslint-disable-next-line prefer-const */
             let [header, regex] = this.options.filter.split('=');
             const isNot = header[0] === '-';
             if (isNot)
@@ -77,12 +80,10 @@ class Table {
         // sort rows
         if (this.options.sort) {
             const sorters = this.options.sort.split(',');
-            const sortHeaders = sorters.map(k => k[0] === '-' ? k.slice(1) : k);
-            const sortKeys = this.filterColumnsFromHeaders(sortHeaders).map(c => {
-                return ((v) => v[c.key]);
-            });
-            const sortKeysOrder = sorters.map(k => k[0] === '-' ? 'desc' : 'asc');
-            rows = orderBy(rows, sortKeys, sortKeysOrder);
+            const sortHeaders = sorters.map((k) => (k[0] === '-' ? k.slice(1) : k));
+            const sortKeys = this.filterColumnsFromHeaders(sortHeaders).map((c) => (v) => v[c.key]);
+            const sortKeysOrder = sorters.map((k) => (k[0] === '-' ? 'desc' : 'asc'));
+            rows = (0, natural_orderby_1.orderBy)(rows, sortKeys, sortKeysOrder);
         }
         // and filter columns
         if (this.options.columns) {
@@ -91,53 +92,49 @@ class Table {
         }
         else if (!this.options.extended) {
             // show extented columns/properties
-            this.columns = this.columns.filter(c => !c.extended);
+            this.columns = this.columns.filter((c) => !c.extended);
         }
         this.data = rows;
         switch (this.options.output) {
-            case 'csv':
+            case 'csv': {
                 this.outputCSV();
                 break;
-            case 'json':
+            }
+            case 'json': {
                 this.outputJSON();
                 break;
-            case 'yaml':
+            }
+            case 'yaml': {
                 this.outputYAML();
                 break;
-            default:
+            }
+            default: {
                 this.outputTable();
+            }
         }
     }
     findColumnFromHeader(header) {
-        return this.columns.find(c => c.header.toLowerCase() === header.toLowerCase());
+        return this.columns.find((c) => c.header.toLowerCase() === header.toLowerCase());
     }
     filterColumnsFromHeaders(filters) {
         // unique
-        filters = [...(new Set(filters))];
+        filters = [...new Set(filters)];
         const cols = [];
         for (const f of filters) {
-            const c = this.columns.find(c => c.header.toLowerCase() === f.toLowerCase());
+            const c = this.columns.find((c) => c.header.toLowerCase() === f.toLowerCase());
             if (c)
                 cols.push(c);
         }
         return cols;
     }
     getCSVRow(d) {
-        const values = this.columns.map(col => d[col.key] || '');
+        const values = this.columns.map((col) => d[col.key] || '');
         const lineToBeEscaped = values.find((e) => e.includes('"') || e.includes('\n') || e.includes('\r\n') || e.includes('\r') || e.includes(','));
-        return values.map(e => lineToBeEscaped ? `"${e.replace('"', '""')}"` : e);
+        return values.map((e) => (lineToBeEscaped ? `"${e.replace('"', '""')}"` : e));
     }
     resolveColumnsToObjectArray() {
         const { data, columns } = this;
-        return data.map((d) => {
-            // eslint-disable-next-line unicorn/prefer-object-from-entries
-            return columns.reduce((obj, col) => {
-                return {
-                    ...obj,
-                    [col.key]: d[col.key] ?? '',
-                };
-            }, {});
-        });
+        return data.map((d) => Object.fromEntries(columns.map((col) => [col.key, d[col.key] ?? ''])));
     }
     outputJSON() {
         this.options.printLine(JSON.stringify(this.resolveColumnsToObjectArray(), undefined, 2));
@@ -148,7 +145,7 @@ class Table {
     outputCSV() {
         const { data, columns, options } = this;
         if (!options['no-header']) {
-            options.printLine(columns.map(c => c.header).join(','));
+            options.printLine(columns.map((c) => c.header).join(','));
         }
         for (const d of data) {
             const row = this.getCSVRow(d);
@@ -160,8 +157,8 @@ class Table {
         // column truncation
         //
         // find max width for each column
-        const columns = this.columns.map(c => {
-            const maxWidth = Math.max(sw('.'.padEnd(c.minWidth - 1)), sw(c.header), getWidestColumnWith(data, c.key)) + 1;
+        const columns = this.columns.map((c) => {
+            const maxWidth = Math.max((0, string_width_1.default)('.'.padEnd(c.minWidth - 1)), (0, string_width_1.default)(c.header), getWidestColumnWith(data, c.key)) + 1;
             return {
                 ...c,
                 maxWidth,
@@ -176,7 +173,7 @@ class Table {
             if (options['no-truncate'] || (!stream_1.stdout.isTTY && !process.env.CLI_UX_SKIP_TTY_CHECK))
                 return;
             // don't shorten if there is enough screen width
-            const dataMaxWidth = (0, util_1.sumBy)(columns, c => c.width);
+            const dataMaxWidth = (0, util_1.sumBy)(columns, (c) => c.width);
             const overWidth = dataMaxWidth - maxWidth;
             if (overWidth <= 0)
                 return;
@@ -187,16 +184,18 @@ class Table {
             // if sum(minWidth's) is greater than term width
             // nothing can be done so
             // display all as minWidth
-            const dataMinWidth = (0, util_1.sumBy)(columns, c => c.minWidth);
+            const dataMinWidth = (0, util_1.sumBy)(columns, (c) => c.minWidth);
             if (dataMinWidth >= maxWidth)
                 return;
             // some wiggle room left, add it back to "needy" columns
             let wiggleRoom = maxWidth - dataMinWidth;
-            const needyCols = columns.map(c => ({ key: c.key, needs: c.maxWidth - c.width })).sort((a, b) => a.needs - b.needs);
+            const needyCols = columns
+                .map((c) => ({ key: c.key, needs: c.maxWidth - c.width }))
+                .sort((a, b) => a.needs - b.needs);
             for (const { key, needs } of needyCols) {
                 if (!needs)
                     continue;
-                const col = columns.find(c => key === c.key);
+                const col = columns.find((c) => key === c.key);
                 if (!col)
                     continue;
                 if (wiggleRoom > needs) {
@@ -224,14 +223,14 @@ class Table {
                 const header = col.header;
                 headers += header.padEnd(col.width);
             }
-            options.printLine(chalk.bold(headers));
+            options.printLine(chalk_1.default.bold(headers));
             // print header dividers
             let dividers = options.rowStart;
             for (const col of columns) {
                 const divider = ''.padEnd(col.width - 1, '─') + ' ';
                 dividers += divider.padEnd(col.width);
             }
-            options.printLine(chalk.bold(dividers));
+            options.printLine(chalk_1.default.bold(dividers));
         }
         // print rows
         for (const row of data) {
@@ -255,16 +254,16 @@ class Table {
                     const width = col.width;
                     let d = row[col.key];
                     d = d.split('\n')[i] || '';
-                    const visualWidth = sw(d);
-                    const colorWidth = (d.length - visualWidth);
+                    const visualWidth = (0, string_width_1.default)(d);
+                    const colorWidth = d.length - visualWidth;
                     let cell = d.padEnd(width + colorWidth);
-                    if ((cell.length - colorWidth) > width || visualWidth === width) {
+                    if (cell.length - colorWidth > width || visualWidth === width) {
                         // truncate the cell, preserving ANSI escape sequences, and keeping
                         // into account the width of fullwidth unicode characters
-                        cell = sliceAnsi(cell, 0, width - 2) + '… ';
+                        cell = (0, slice_ansi_1.default)(cell, 0, width - 2) + '… ';
                         // pad with spaces; this is necessary in case the original string
                         // contained fullwidth characters which cannot be split
-                        cell += ' '.repeat(width - sw(cell));
+                        cell += ' '.repeat(width - (0, string_width_1.default)(cell));
                     }
                     l += cell;
                 }
@@ -280,7 +279,7 @@ exports.table = table;
 (function (table) {
     table.Flags = {
         columns: F.string({ exclusive: ['extended'], description: 'only show provided columns (comma-separated)' }),
-        sort: F.string({ description: 'property to sort by (prepend \'-\' for descending)' }),
+        sort: F.string({ description: "property to sort by (prepend '-' for descending)" }),
         filter: F.string({ description: 'filter property by partial string matching, ex: name=foo' }),
         csv: F.boolean({ exclusive: ['no-truncate'], description: 'output is csv format [alias: --output=csv]' }),
         output: F.string({
@@ -292,7 +291,6 @@ exports.table = table;
         'no-truncate': F.boolean({ exclusive: ['csv'], description: 'do not truncate output to fit screen' }),
         'no-header': F.boolean({ exclusive: ['csv'], description: 'hide table header from output' }),
     };
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     function flags(opts) {
         if (opts) {
             const f = {};
@@ -300,6 +298,7 @@ exports.table = table;
             const e = (opts.except && typeof opts.except === 'string' ? [opts.except] : opts.except) || [];
             for (const key of o) {
                 if (!e.includes(key)) {
+                    ;
                     f[key] = table.Flags[key];
                 }
             }
@@ -308,13 +307,11 @@ exports.table = table;
         return table.Flags;
     }
     table.flags = flags;
-})(table = exports.table || (exports.table = {}));
-const getWidestColumnWith = (data, columnKey) => {
-    return data.reduce((previous, current) => {
-        const d = current[columnKey];
-        // convert multi-line cell to single longest line
-        // for width calculations
-        const manyLines = d.split('\n');
-        return Math.max(previous, manyLines.length > 1 ? Math.max(...manyLines.map((r) => sw(r))) : sw(d));
-    }, 0);
-};
+})(table || (exports.table = table = {}));
+const getWidestColumnWith = (data, columnKey) => data.reduce((previous, current) => {
+    const d = current[columnKey];
+    // convert multi-line cell to single longest line
+    // for width calculations
+    const manyLines = d.split('\n');
+    return Math.max(previous, manyLines.length > 1 ? Math.max(...manyLines.map((r) => (0, string_width_1.default)(r))) : (0, string_width_1.default)(d));
+}, 0);

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/cli-ux/wait.js

@@ -1,7 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = (ms = 1000) => {
-    return new Promise(resolve => {
-        setTimeout(resolve, ms);
-    });
-};
+exports.default = (ms = 1000) => new Promise((resolve) => {
+    setTimeout(resolve, ms);
+});

package/lib/command.d.ts

@@ -1,9 +1,9 @@
+import { ArgInput, ArgOutput, ArgProps, BooleanFlagProps, Deprecation, FlagInput, FlagOutput, Arg as IArg, Flag as IFlag, Input, OptionFlagProps, ParserOutput } from './interfaces/parser';
+import { CommandError } from './interfaces/errors';
 import { Config } from './config';
-import { PrettyPrintableError } from './errors';
-import { BooleanFlagProps, CompletableFlag, Deprecation, Arg as IArg, ArgInput, FlagInput, FlagOutput, Input, ArgProps, OptionFlagProps, ParserOutput, ArgOutput } from './interfaces/parser';
-import { Plugin } from './interfaces/plugin';
 import { LoadOptions } from './interfaces/config';
-import { CommandError } from './interfaces/errors';
+import { Plugin } from './interfaces/plugin';
+import { PrettyPrintableError } from './errors';
 /**
  * An abstract class which acts as the base for each command
  * in your project.
@@ -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);
@@ -157,10 +147,16 @@ export declare namespace Command {
             [name: string]: Arg.Cached;
         };
         hasDynamicHelp?: boolean;
+        permutations?: string[];
+        aliasPermutations?: string[];
+        isESM?: boolean;
+        relativePath?: string[];
     };
-    type Flag = CompletableFlag<any>;
+    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>;