@oclif/core 3.26.6 → 4.0.0-beta.10

package/lib/util/read-pjson.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readPjson = void 0;
+const cosmiconfig_1 = require("cosmiconfig");
+const node_path_1 = require("node:path");
+const logger_1 = require("../logger");
+const fs_1 = require("./fs");
+const debug = (0, logger_1.makeDebug)('read-pjson');
+/**
+ * Read the package.json file from a given path and add the oclif config (found by cosmiconfig) if it exists.
+ *
+ * We can assume that the package.json file exists because the plugin root has already been loaded at this point.
+ */
+async function readPjson(path) {
+    const pjsonPath = (0, node_path_1.join)(path, 'package.json');
+    if (process.env.OCLIF_DISABLE_RC) {
+        debug('OCLIF_DISABLE_RC is set, skipping rc search');
+        return (0, fs_1.readJson)(pjsonPath);
+    }
+    const pjson = await (0, fs_1.readJson)(pjsonPath);
+    // don't bother with cosmiconfig if the plugin's package.json already has an oclif config
+    if (pjson.oclif) {
+        debug(`found oclif config in ${pjsonPath}`);
+        return pjson;
+    }
+    debug(`searching for oclif config in ${path}`);
+    const explorer = (0, cosmiconfig_1.cosmiconfig)('oclif', {
+        /**
+         * Remove the following from the defaults:
+         * - package.json
+         * - any files under .config/
+         */
+        searchPlaces: [
+            '.oclifrc',
+            '.oclifrc.json',
+            '.oclifrc.yaml',
+            '.oclifrc.yml',
+            '.oclifrc.js',
+            '.oclifrc.ts',
+            '.oclifrc.mjs',
+            '.oclifrc.cjs',
+            'oclif.config.js',
+            'oclif.config.ts',
+            'oclif.config.mjs',
+            'oclif.config.cjs',
+        ],
+        searchStrategy: 'none',
+    });
+    const result = await explorer.search(path);
+    if (!result?.config) {
+        debug(`no oclif config found in ${path}`);
+        return pjson;
+    }
+    debug(`found oclif config for ${path}: %O`, result);
+    return {
+        ...pjson,
+        oclif: result?.config ?? {},
+    };
+}
+exports.readPjson = readPjson;

package/lib/util/read-tsconfig.js

@@ -1,15 +1,12 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readTSConfig = void 0;
-const debug_1 = __importDefault(require("debug"));
 const promises_1 = require("node:fs/promises");
 const node_path_1 = require("node:path");
 const warn_1 = require("../errors/warn");
+const logger_1 = require("../logger");
 const util_1 = require("./util");
-const debug = (0, debug_1.default)('read-tsconfig');
+const debug = (0, logger_1.makeDebug)('read-tsconfig');
 function resolve(root, name) {
     try {
         return require.resolve(name, { paths: [root] });
@@ -50,9 +47,7 @@ async function readTSConfig(root, tsconfigName = 'tsconfig.json') {
         return;
     }
     const read = async (path) => {
-        const localRoot = await upUntil(path, async (p) => 
-        // eslint-disable-next-line unicorn/no-await-expression-member
-        (await (0, promises_1.readdir)(p)).includes('package.json'));
+        const localRoot = await upUntil(path, async (p) => (await (0, promises_1.readdir)(p)).includes('package.json'));
         if (!localRoot)
             return;
         try {

package/lib/{cli-ux → ux}/action/base.d.ts

@@ -1,13 +1,10 @@
 import { Options } from './types';
-export interface ITask {
+type Task = {
     action: string;
     active: boolean;
     status: string | undefined;
-}
+};
 export type ActionType = 'debug' | 'simple' | 'spinner';
-/**
- * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
- */
 export declare class ActionBase {
     std: 'stderr' | 'stdout';
     protected stdmocks?: ['stderr' | 'stdout', string[]][];
@@ -18,8 +15,8 @@ export declare class ActionBase {
     get running(): boolean;
     get status(): string | undefined;
     set status(status: string | undefined);
-    get task(): ITask | undefined;
-    set task(task: ITask | undefined);
+    get task(): Task | undefined;
+    set task(task: Task | undefined);
     pause(fn: () => any, icon?: string): Promise<any>;
     pauseAsync<T>(fn: () => Promise<T>, icon?: string): Promise<T>;
     start(action: string, status?: string, opts?: Options): void;
@@ -34,3 +31,4 @@ export declare class ActionBase {
     protected _write(std: 'stderr' | 'stdout', s: string | string[]): void;
     private get globals();
 }
+export {};

package/lib/{cli-ux → ux}/action/base.js

@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionBase = void 0;
 const node_util_1 = require("node:util");
 const util_1 = require("../../util/util");
-/**
- * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
- */
 class ActionBase {
     std = 'stderr';
     stdmocks;

package/lib/{cli-ux → ux}/action/spinner.d.ts

@@ -1,12 +1,13 @@
-/// <reference types="node" />
 import { ActionBase, ActionType } from './base';
 import { Options } from './types';
 export default class SpinnerAction extends ActionBase {
-    frameIndex: number;
-    frames: string[];
-    spinner?: NodeJS.Timeout;
     type: ActionType;
+    private color;
+    private frameIndex;
+    private frames;
+    private spinner?;
     constructor();
+    protected colorize(s: string): string;
     protected _frame(): string;
     private _lines;
     protected _pause(icon?: string): void;

package/lib/{cli-ux → ux}/action/spinner.js

@@ -1,62 +1,38 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ansi_styles_1 = __importDefault(require("ansi-styles"));
-const chalk_1 = __importDefault(require("chalk"));
-const strip_ansi_1 = __importDefault(require("strip-ansi"));
-const supportsColor = __importStar(require("supports-color"));
+const ansis_1 = __importDefault(require("ansis"));
+const cli_spinners_1 = __importDefault(require("cli-spinners"));
+const cache_1 = __importDefault(require("../../cache"));
 const screen_1 = require("../../screen");
+const theme_1 = require("../theme");
 const base_1 = require("./base");
-const spinners_1 = __importDefault(require("./spinners"));
 const ansiEscapes = require('ansi-escapes');
-function color(s) {
-    if (!supportsColor)
-        return s;
-    const has256 = supportsColor.stdout ? supportsColor.stdout.has256 : (process.env.TERM || '').includes('256');
-    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';
+    color = 'magenta';
     frameIndex;
     frames;
     spinner;
-    type = 'spinner';
     constructor() {
         super();
         this.frames = this.getFrames();
         this.frameIndex = 0;
     }
+    colorize(s) {
+        return (0, theme_1.colorize)(this.color, s);
+    }
     _frame() {
         const frame = this.frames[this.frameIndex];
         this.frameIndex = ++this.frameIndex % this.frames.length;
-        return color(frame);
+        return this.colorize(frame);
     }
     _lines(s) {
-        return (0, strip_ansi_1.default)(s).split('\n').map((l) => Math.ceil(l.length / screen_1.errtermwidth)).reduce((c, i) => c + i, 0);
+        return ansis_1.default.strip(s).split('\n')
+            .map((l) => Math.ceil(l.length / screen_1.errtermwidth))
+            .reduce((c, i) => c + i, 0);
     }
     _pause(icon) {
         if (this.spinner)
@@ -84,6 +60,7 @@ class SpinnerAction extends base_1.ActionBase {
         this.output = undefined;
     }
     _start(opts) {
+        this.color = cache_1.default.getInstance().get('config')?.theme?.spinner ?? this.color;
         if (opts.style)
             this.frames = this.getFrames(opts);
         this._reset();
@@ -104,8 +81,8 @@ class SpinnerAction extends base_1.ActionBase {
     }
     getFrames(opts) {
         if (opts?.style)
-            return spinners_1.default[opts.style].frames;
-        return spinners_1.default[process.platform === 'win32' ? 'line' : 'dots2'].frames;
+            return cli_spinners_1.default[opts.style].frames;
+        return cli_spinners_1.default[process.platform === 'win32' ? 'line' : 'dots2'].frames;
     }
 }
 exports.default = SpinnerAction;

package/lib/ux/action/types.d.ts

@@ -0,0 +1,5 @@
+import * as spinners from 'cli-spinners';
+export type Options = {
+    stdout?: boolean;
+    style?: spinners.SpinnerName | 'random';
+};

package/lib/ux/action/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/ux/colorize-json.d.ts

@@ -0,0 +1,28 @@
+type Options = {
+    pretty?: boolean | undefined;
+    theme?: Record<string, string> | undefined;
+};
+export declare function tokenize(json?: unknown, options?: Options): {
+    type: string;
+    value: string;
+}[];
+/**
+ * Add color to JSON.
+ *
+ * options
+ *  pretty: set to true to pretty print the JSON (defaults to true)
+ *  theme: theme to use for colorizing. See keys below for available options. All keys are optional and must be valid colors (e.g. hex code, rgb, or standard ansi color).
+ *
+ * Available theme keys:
+ * - brace
+ * - bracket
+ * - colon
+ * - comma
+ * - key
+ * - string
+ * - number
+ * - boolean
+ * - null
+ */
+export default function colorizeJson(json: unknown, options?: Options): string;
+export {};

package/lib/ux/colorize-json.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tokenize = void 0;
+const theme_1 = require("./theme");
+const tokenTypes = [
+    { regex: /^\s+/, tokenType: 'whitespace' },
+    { regex: /^[{}]/, tokenType: 'brace' },
+    { regex: /^[[\]]/, tokenType: 'bracket' },
+    { regex: /^:/, tokenType: 'colon' },
+    { regex: /^,/, tokenType: 'comma' },
+    { regex: /^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?/i, tokenType: 'number' },
+    { regex: /^"(?:\\.|[^"\\])*"(?=\s*:)/, tokenType: 'key' },
+    { regex: /^"(?:\\.|[^"\\])*"/, tokenType: 'string' },
+    { regex: /^true|^false/, tokenType: 'boolean' },
+    { regex: /^null/, tokenType: 'null' },
+];
+function formatInput(json, options) {
+    return options?.pretty
+        ? JSON.stringify(typeof json === 'string' ? JSON.parse(json) : json, null, 2)
+        : typeof json === 'string'
+            ? json
+            : JSON.stringify(json);
+}
+function tokenize(json, options) {
+    let input = formatInput(json, options);
+    const tokens = [];
+    let foundToken = false;
+    do {
+        for (const tokenType of tokenTypes) {
+            const match = tokenType.regex.exec(input);
+            if (match) {
+                tokens.push({ type: tokenType.tokenType, value: match[0] });
+                input = input.slice(match[0].length);
+                foundToken = true;
+                break;
+            }
+        }
+    } while (hasRemainingTokens(input, foundToken));
+    return tokens;
+}
+exports.tokenize = tokenize;
+function hasRemainingTokens(input, foundToken) {
+    return (input?.length ?? 0) > 0 && foundToken;
+}
+/**
+ * Add color to JSON.
+ *
+ * options
+ *  pretty: set to true to pretty print the JSON (defaults to true)
+ *  theme: theme to use for colorizing. See keys below for available options. All keys are optional and must be valid colors (e.g. hex code, rgb, or standard ansi color).
+ *
+ * Available theme keys:
+ * - brace
+ * - bracket
+ * - colon
+ * - comma
+ * - key
+ * - string
+ * - number
+ * - boolean
+ * - null
+ */
+function colorizeJson(json, options) {
+    const opts = { ...options, pretty: options?.pretty ?? true };
+    return tokenize(json, opts).reduce((acc, token) => acc + (0, theme_1.colorize)(options?.theme?.[token.type], token.value), '');
+}
+exports.default = colorizeJson;

package/lib/ux/index.d.ts

@@ -0,0 +1,69 @@
+import { error } from '../errors/error';
+import { exit } from '../errors/exit';
+import { warn } from '../errors/warn';
+import Simple from './action/simple';
+import Spinner from './action/spinner';
+import colorizeJson from './colorize-json';
+import { colorize } from './theme';
+export { error } from '../errors/error';
+export { exit } from '../errors/exit';
+export { warn } from '../errors/warn';
+export { default as colorizeJson } from './colorize-json';
+export { colorize } from './theme';
+export { stderr, stdout } from './write';
+export declare const ux: {
+    action: Simple | Spinner;
+    /**
+     * Add color to text.
+     * @param color color to use. Can be hex code (e.g. `#ff0000`), rgb (e.g. `rgb(255, 255, 255)`) or a standard ansi color (e.g. `red`)
+     * @param text string to colorize
+     * @returns colorized string
+     */
+    colorize: typeof colorize;
+    /**
+     * Add color to JSON.
+     *
+     * options
+     *  pretty: set to true to pretty print the JSON (defaults to true)
+     *  theme: theme to use for colorizing. See keys below for available options. All keys are optional and must be valid colors (e.g. hex code, rgb, or standard ansi color).
+     *
+     * Available theme keys:
+     * - brace
+     * - bracket
+     * - colon
+     * - comma
+     * - key
+     * - string
+     * - number
+     * - boolean
+     * - null
+     */
+    colorizeJson: typeof colorizeJson;
+    /**
+     * Throw an error.
+     *
+     * If `exit` option is `false`, the error will be logged to stderr but not exit the process.
+     * If `exit` is set to a number, the process will exit with that code.
+     */
+    error: typeof error;
+    /**
+     * Exit the process with provided exit code (defaults to 0).
+     */
+    exit: typeof exit;
+    /**
+     * Log a formatted string to stderr.
+     *
+     * See node's util.format() for formatting options.
+     */
+    stderr: (str: string | string[] | undefined, ...args: string[]) => void;
+    /**
+     * Log a formatted string to stdout.
+     *
+     * See node's util.format() for formatting options.
+     */
+    stdout: (str: string | string[] | undefined, ...args: string[]) => void;
+    /**
+     * Prints a pretty warning message to stderr.
+     */
+    warn: typeof warn;
+};

package/lib/ux/index.js

@@ -0,0 +1,88 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ux = exports.stdout = exports.stderr = exports.colorize = exports.colorizeJson = exports.warn = exports.exit = exports.error = void 0;
+const error_1 = require("../errors/error");
+const exit_1 = require("../errors/exit");
+const warn_1 = require("../errors/warn");
+const simple_1 = __importDefault(require("./action/simple"));
+const spinner_1 = __importDefault(require("./action/spinner"));
+const colorize_json_1 = __importDefault(require("./colorize-json"));
+const theme_1 = require("./theme");
+const write_1 = require("./write");
+var error_2 = require("../errors/error");
+Object.defineProperty(exports, "error", { enumerable: true, get: function () { return error_2.error; } });
+var exit_2 = require("../errors/exit");
+Object.defineProperty(exports, "exit", { enumerable: true, get: function () { return exit_2.exit; } });
+var warn_2 = require("../errors/warn");
+Object.defineProperty(exports, "warn", { enumerable: true, get: function () { return warn_2.warn; } });
+var colorize_json_2 = require("./colorize-json");
+Object.defineProperty(exports, "colorizeJson", { enumerable: true, get: function () { return __importDefault(colorize_json_2).default; } });
+var theme_2 = require("./theme");
+Object.defineProperty(exports, "colorize", { enumerable: true, get: function () { return theme_2.colorize; } });
+var write_2 = require("./write");
+Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return write_2.stderr; } });
+Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return write_2.stdout; } });
+const ACTION_TYPE = (Boolean(process.stderr.isTTY) &&
+    !process.env.CI &&
+    !['dumb', 'emacs-color'].includes(process.env.TERM) &&
+    'spinner') ||
+    'simple';
+exports.ux = {
+    action: ACTION_TYPE === 'spinner' ? new spinner_1.default() : new simple_1.default(),
+    /**
+     * Add color to text.
+     * @param color color to use. Can be hex code (e.g. `#ff0000`), rgb (e.g. `rgb(255, 255, 255)`) or a standard ansi color (e.g. `red`)
+     * @param text string to colorize
+     * @returns colorized string
+     */
+    colorize: theme_1.colorize,
+    /**
+     * Add color to JSON.
+     *
+     * options
+     *  pretty: set to true to pretty print the JSON (defaults to true)
+     *  theme: theme to use for colorizing. See keys below for available options. All keys are optional and must be valid colors (e.g. hex code, rgb, or standard ansi color).
+     *
+     * Available theme keys:
+     * - brace
+     * - bracket
+     * - colon
+     * - comma
+     * - key
+     * - string
+     * - number
+     * - boolean
+     * - null
+     */
+    colorizeJson: colorize_json_1.default,
+    /**
+     * Throw an error.
+     *
+     * If `exit` option is `false`, the error will be logged to stderr but not exit the process.
+     * If `exit` is set to a number, the process will exit with that code.
+     */
+    error: error_1.error,
+    /**
+     * Exit the process with provided exit code (defaults to 0).
+     */
+    exit: exit_1.exit,
+    /**
+     * Log a formatted string to stderr.
+     *
+     * See node's util.format() for formatting options.
+     */
+    stderr: write_1.stderr,
+    /**
+     * Log a formatted string to stdout.
+     *
+     * See node's util.format() for formatting options.
+     */
+    stdout: write_1.stdout,
+    /**
+     * Prints a pretty warning message to stderr.
+     */
+    warn: warn_1.warn,
+};

package/lib/{cli-ux → ux}/list.d.ts

@@ -1,3 +1,3 @@
 export type IListItem = [string, string | undefined];
 export type IList = IListItem[];
-export declare function renderList(items: IListItem[]): string;
+export default function renderList(items: IListItem[]): string;

package/lib/{cli-ux → ux}/list.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderList = void 0;
 const screen_1 = require("../screen");
 const util_1 = require("../util/util");
 const wordwrap = require('wordwrap');
@@ -26,4 +25,4 @@ function renderList(items) {
     });
     return lines.join('\n');
 }
-exports.renderList = renderList;
+exports.default = renderList;

package/lib/ux/theme.d.ts

@@ -0,0 +1,9 @@
+import { StandardAnsi, Theme } from '../interfaces/theme';
+/**
+ * Add color to text.
+ * @param color color to use. Can be hex code (e.g. `#ff0000`), rgb (e.g. `rgb(255, 255, 255)`) or a standard ansi color (e.g. `red`)
+ * @param text string to colorize
+ * @returns colorized string
+ */
+export declare function colorize(color: string | StandardAnsi | undefined, text: string): string;
+export declare function parseTheme(theme: Record<string, string | Record<string, string>>): Theme;

package/lib/ux/theme.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTheme = exports.colorize = void 0;
+const ansis_1 = __importDefault(require("ansis"));
+const theme_1 = require("../interfaces/theme");
+function isStandardChalk(color) {
+    return theme_1.STANDARD_ANSI.includes(color);
+}
+/**
+ * Add color to text.
+ * @param color color to use. Can be hex code (e.g. `#ff0000`), rgb (e.g. `rgb(255, 255, 255)`) or a standard ansi color (e.g. `red`)
+ * @param text string to colorize
+ * @returns colorized string
+ */
+function colorize(color, text) {
+    if (!color)
+        return text;
+    if (isStandardChalk(color))
+        return ansis_1.default[color](text);
+    if (color.startsWith('#'))
+        return ansis_1.default.hex(color)(text);
+    if (color.startsWith('rgb')) {
+        const [red, green, blue] = color
+            .slice(4, -1)
+            .split(',')
+            .map((c) => Number.parseInt(c.trim(), 10));
+        return ansis_1.default.rgb(red, green, blue)(text);
+    }
+    return text;
+}
+exports.colorize = colorize;
+function parseTheme(theme) {
+    return Object.fromEntries(Object.entries(theme)
+        .map(([key, value]) => [key, typeof value === 'string' ? isValid(value) : parseTheme(value)])
+        .filter(([_, value]) => value));
+}
+exports.parseTheme = parseTheme;
+function isValid(color) {
+    return color.startsWith('#') || color.startsWith('rgb') || isStandardChalk(color) ? color : undefined;
+}

package/lib/ux/write.d.ts

@@ -0,0 +1,2 @@
+export declare const stdout: (str: string | string[] | undefined, ...args: string[]) => void;
+export declare const stderr: (str: string | string[] | undefined, ...args: string[]) => void;

package/lib/ux/write.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stderr = exports.stdout = void 0;
+const node_util_1 = require("node:util");
+const stdout = (str, ...args) => {
+    if (typeof str === 'string' || !str) {
+        process.stdout.write((0, node_util_1.format)(str, ...args) + '\n');
+    }
+    else {
+        process.stdout.write((0, node_util_1.format)(...str, ...args) + '\n');
+    }
+};
+exports.stdout = stdout;
+const stderr = (str, ...args) => {
+    if (typeof str === 'string' || !str) {
+        process.stderr.write((0, node_util_1.format)(str, ...args) + '\n');
+    }
+    else {
+        process.stderr.write((0, node_util_1.format)(...str, ...args) + '\n');
+    }
+};
+exports.stderr = stderr;