@oclif/core 3.26.4 → 4.0.0-beta.2

package/lib/index.d.ts

@@ -1,13 +1,11 @@
 export * as Args from './args';
-export * as ux from './cli-ux';
-export { flush } from './cli-ux/flush';
-export { stderr, stdout } from './cli-ux/stream';
 export { Command } from './command';
 export { Config, Plugin } from './config';
 export * as Errors from './errors';
 export { handle } from './errors/handle';
 export { execute } from './execute';
 export * as Flags from './flags';
+export { flush } from './flush';
 export { CommandHelp, Help, HelpBase, loadHelpClass } from './help';
 export { HelpSection, HelpSectionKeyValueTable, HelpSectionRenderer } from './help/formatter';
 export * as Interfaces from './interfaces';
@@ -18,3 +16,4 @@ export * as Parser from './parser';
 export { Performance } from './performance';
 export { Settings, settings } from './settings';
 export { toConfiguredId, toStandardizedId } from './util/ids';
+export { methods as ux } from './ux';

package/lib/index.js

@@ -22,30 +22,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __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 });
-exports.toStandardizedId = exports.toConfiguredId = exports.settings = exports.Performance = exports.Parser = exports.ModuleLoader = exports.run = exports.Interfaces = exports.loadHelpClass = exports.HelpBase = exports.Help = exports.CommandHelp = exports.Flags = exports.execute = exports.handle = exports.Errors = exports.Plugin = exports.Config = exports.Command = exports.stdout = exports.stderr = exports.flush = exports.ux = exports.Args = void 0;
-const write_1 = __importDefault(require("./cli-ux/write"));
+exports.ux = exports.toStandardizedId = exports.toConfiguredId = exports.settings = exports.Performance = exports.Parser = exports.ModuleLoader = exports.run = exports.Interfaces = exports.loadHelpClass = exports.HelpBase = exports.Help = exports.CommandHelp = exports.flush = exports.Flags = exports.execute = exports.handle = exports.Errors = exports.Plugin = exports.Config = exports.Command = exports.Args = void 0;
 function checkCWD() {
     try {
         process.cwd();
     }
     catch (error) {
         if (error.code === 'ENOENT') {
-            write_1.default.stderr('WARNING: current directory does not exist\n');
+            process.stderr.write('WARNING: current directory does not exist\n');
         }
     }
 }
 checkCWD();
 exports.Args = __importStar(require("./args"));
-exports.ux = __importStar(require("./cli-ux"));
-var flush_1 = require("./cli-ux/flush");
-Object.defineProperty(exports, "flush", { enumerable: true, get: function () { return flush_1.flush; } });
-var stream_1 = require("./cli-ux/stream"); // Remove these in the next major version
-Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return stream_1.stderr; } });
-Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return stream_1.stdout; } });
 var command_1 = require("./command");
 Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
 var config_1 = require("./config");
@@ -57,6 +47,8 @@ Object.defineProperty(exports, "handle", { enumerable: true, get: function () {
 var execute_1 = require("./execute");
 Object.defineProperty(exports, "execute", { enumerable: true, get: function () { return execute_1.execute; } });
 exports.Flags = __importStar(require("./flags"));
+var flush_1 = require("./flush");
+Object.defineProperty(exports, "flush", { enumerable: true, get: function () { return flush_1.flush; } });
 var help_1 = require("./help");
 Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return help_1.CommandHelp; } });
 Object.defineProperty(exports, "Help", { enumerable: true, get: function () { return help_1.Help; } });
@@ -74,3 +66,5 @@ Object.defineProperty(exports, "settings", { enumerable: true, get: function ()
 var ids_1 = require("./util/ids");
 Object.defineProperty(exports, "toConfiguredId", { enumerable: true, get: function () { return ids_1.toConfiguredId; } });
 Object.defineProperty(exports, "toStandardizedId", { enumerable: true, get: function () { return ids_1.toStandardizedId; } });
+var ux_1 = require("./ux");
+Object.defineProperty(exports, "ux", { enumerable: true, get: function () { return ux_1.methods; } });

package/lib/interfaces/config.d.ts

@@ -126,6 +126,7 @@ export interface Config {
     readonly theme?: Theme;
     topicSeparator: ' ' | ':';
     readonly topics: Topic[];
+    readonly updateConfig: NonNullable<PJSON.CLI['oclif']['update']>;
     /**
      * user agent to use for http calls
      *

package/lib/interfaces/pjson.d.ts

@@ -148,7 +148,7 @@ export declare namespace PJSON {
                     subtopics?: Plugin['oclif']['topics'];
                 };
             };
-            update: {
+            update?: {
                 autoupdate?: {
                     debounce?: number;
                     rollout?: number;

package/lib/interfaces/theme.d.ts

@@ -1,21 +1,32 @@
-export declare const STANDARD_CHALK: readonly ["white", "black", "blue", "yellow", "green", "red", "magenta", "cyan", "gray", "blackBright", "redBright", "greenBright", "yellowBright", "blueBright", "magentaBright", "cyanBright", "whiteBright", "bgBlack", "bgRed", "bgGreen", "bgYellow", "bgBlue", "bgMagenta", "bgCyan", "bgWhite", "bgGray", "bgBlackBright", "bgRedBright", "bgGreenBright", "bgYellowBright", "bgBlueBright", "bgMagentaBright", "bgCyanBright", "bgWhiteBright", "bold", "underline", "dim", "italic", "strikethrough"];
-export type StandardChalk = (typeof STANDARD_CHALK)[number];
-export declare const THEME_KEYS: readonly ["alias", "bin", "command", "commandSummary", "dollarSign", "flag", "flagDefaultValue", "flagOptions", "flagRequired", "flagSeparator", "sectionDescription", "sectionHeader", "topic", "version"];
-export type ThemeKey = (typeof THEME_KEYS)[number];
+export declare const STANDARD_ANSI: readonly ["white", "black", "blue", "yellow", "green", "red", "magenta", "cyan", "gray", "blackBright", "redBright", "greenBright", "yellowBright", "blueBright", "magentaBright", "cyanBright", "whiteBright", "bgBlack", "bgRed", "bgGreen", "bgYellow", "bgBlue", "bgMagenta", "bgCyan", "bgWhite", "bgGray", "bgBlackBright", "bgRedBright", "bgGreenBright", "bgYellowBright", "bgBlueBright", "bgMagentaBright", "bgCyanBright", "bgWhiteBright", "bold", "underline", "dim", "italic", "strikethrough"];
+export type StandardAnsi = (typeof STANDARD_ANSI)[number];
+export type JsonTheme = {
+    brace?: string | StandardAnsi;
+    bracket?: string | StandardAnsi;
+    colon?: string | StandardAnsi;
+    comma?: string | StandardAnsi;
+    key?: string | StandardAnsi;
+    string?: string | StandardAnsi;
+    number?: string | StandardAnsi;
+    boolean?: string | StandardAnsi;
+    null?: string | StandardAnsi;
+};
 export type Theme = {
-    [key: string | ThemeKey]: string | StandardChalk | undefined;
-    alias?: string | StandardChalk;
-    bin?: string | StandardChalk;
-    command?: string | StandardChalk;
-    commandSummary?: string | StandardChalk;
-    dollarSign?: string | StandardChalk;
-    flag?: string | StandardChalk;
-    flagDefaultValue?: string | StandardChalk;
-    flagOptions?: string | StandardChalk;
-    flagRequired?: string | StandardChalk;
-    flagSeparator?: string | StandardChalk;
-    sectionDescription?: string | StandardChalk;
-    sectionHeader?: string | StandardChalk;
-    topic?: string | StandardChalk;
-    version?: string | StandardChalk;
+    [key: string]: string | StandardAnsi | Theme | undefined;
+    alias?: string | StandardAnsi;
+    bin?: string | StandardAnsi;
+    command?: string | StandardAnsi;
+    commandSummary?: string | StandardAnsi;
+    dollarSign?: string | StandardAnsi;
+    flag?: string | StandardAnsi;
+    flagDefaultValue?: string | StandardAnsi;
+    flagOptions?: string | StandardAnsi;
+    flagRequired?: string | StandardAnsi;
+    flagSeparator?: string | StandardAnsi;
+    json?: JsonTheme;
+    sectionDescription?: string | StandardAnsi;
+    sectionHeader?: string | StandardAnsi;
+    spinner?: string | StandardAnsi;
+    topic?: string | StandardAnsi;
+    version?: string | StandardAnsi;
 };

package/lib/interfaces/theme.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.THEME_KEYS = exports.STANDARD_CHALK = void 0;
-// chalk doesn't export a list of standard colors, so we have to supply our own
-exports.STANDARD_CHALK = [
+exports.STANDARD_ANSI = void 0;
+exports.STANDARD_ANSI = [
     'white',
     'black',
     'blue',
@@ -43,19 +42,3 @@ exports.STANDARD_CHALK = [
     'italic',
     'strikethrough',
 ];
-exports.THEME_KEYS = [
-    'alias',
-    'bin',
-    'command',
-    'commandSummary',
-    'dollarSign',
-    'flag',
-    'flagDefaultValue',
-    'flagOptions',
-    'flagRequired',
-    'flagSeparator',
-    'sectionDescription',
-    'sectionHeader',
-    'topic',
-    'version',
-];

package/lib/main.js

@@ -6,11 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.run = exports.versionAddition = exports.helpAddition = void 0;
 const node_url_1 = require("node:url");
 const cache_1 = __importDefault(require("./cache"));
-const cli_ux_1 = require("./cli-ux");
 const config_1 = require("./config");
 const help_1 = require("./help");
 const performance_1 = require("./performance");
 const symbols_1 = require("./symbols");
+const ux_1 = __importDefault(require("./ux"));
 const debug = require('debug')('oclif:main');
 const helpAddition = (argv, config) => {
     if (argv.length === 0 && !config.isSingleCommandCLI)
@@ -67,7 +67,7 @@ async function run(argv, options) {
     await config.runHook('init', { argv: argvSlice, id });
     // display version if applicable
     if ((0, exports.versionAddition)(argv, config)) {
-        cli_ux_1.ux.log(config.userAgent);
+        ux_1.default.stdout(config.userAgent);
         await collectPerf();
         return;
     }

package/lib/parser/errors.js

@@ -4,11 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FailedFlagValidationError = exports.ArgInvalidOptionError = exports.FlagInvalidOptionError = exports.NonExistentFlagsError = exports.UnexpectedArgsError = exports.RequiredArgsError = exports.InvalidArgsSpecError = exports.CLIParseError = exports.CLIError = void 0;
-const chalk_1 = __importDefault(require("chalk"));
+const ansis_1 = __importDefault(require("ansis"));
 const cache_1 = __importDefault(require("../cache"));
-const list_1 = require("../cli-ux/list");
 const errors_1 = require("../errors");
 const util_1 = require("../util/util");
+const list_1 = __importDefault(require("../ux/list"));
 var errors_2 = require("../errors");
 Object.defineProperty(exports, "CLIError", { enumerable: true, get: function () { return errors_2.CLIError; } });
 class CLIParseError extends errors_1.CLIError {
@@ -27,7 +27,7 @@ class InvalidArgsSpecError extends CLIParseError {
         let message = 'Invalid argument spec';
         const namedArgs = Object.values(args).filter((a) => a.name);
         if (namedArgs.length > 0) {
-            const list = (0, list_1.renderList)(namedArgs.map((a) => [`${a.name} (${a.required ? 'required' : 'optional'})`, a.description]));
+            const list = (0, list_1.default)(namedArgs.map((a) => [`${a.name} (${a.required ? 'required' : 'optional'})`, a.description]));
             message += `:\n${list}`;
         }
         super({ exit: cache_1.default.getInstance().get('exitCodes')?.invalidArgsSpec ?? exit, message, parse });
@@ -41,7 +41,7 @@ class RequiredArgsError extends CLIParseError {
         let message = `Missing ${args.length} required arg${args.length === 1 ? '' : 's'}`;
         const namedArgs = args.filter((a) => a.name);
         if (namedArgs.length > 0) {
-            const list = (0, list_1.renderList)(namedArgs.map((a) => {
+            const list = (0, list_1.default)(namedArgs.map((a) => {
                 const description = a.options ? `(${a.options.join('|')}) ${a.description}` : a.description;
                 return [a.name, description];
             }));
@@ -97,7 +97,7 @@ class FailedFlagValidationError extends CLIParseError {
         const reasons = failed.map((r) => r.reason);
         const deduped = (0, util_1.uniq)(reasons);
         const errString = deduped.length === 1 ? 'error' : 'errors';
-        const message = `The following ${errString} occurred:\n  ${chalk_1.default.dim(deduped.join('\n  '))}`;
+        const message = `The following ${errString} occurred:\n  ${ansis_1.default.dim(deduped.join('\n  '))}`;
         super({ exit: cache_1.default.getInstance().get('exitCodes')?.failedFlagValidation ?? exit, message, parse });
     }
 }

package/lib/parser/help.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.flagUsages = exports.flagUsage = void 0;
-const chalk_1 = __importDefault(require("chalk"));
+const ansis_1 = __importDefault(require("ansis"));
 const util_1 = require("../util/util");
 function flagUsage(flag, options = {}) {
     const label = [];
@@ -21,7 +21,7 @@ function flagUsage(flag, options = {}) {
     let description = flag.summary || flag.description || '';
     if (options.displayRequired && flag.required)
         description = `(required) ${description}`;
-    description = description ? chalk_1.default.dim(description) : undefined;
+    description = description ? ansis_1.default.dim(description) : undefined;
     return [` ${label.join(',').trim()}${usage}`, description];
 }
 exports.flagUsage = flagUsage;

package/lib/util/read-tsconfig.js

@@ -46,7 +46,7 @@ async function readTSConfig(root, tsconfigName = 'tsconfig.json') {
         catch { }
     }
     if (!typescript) {
-        (0, warn_1.memoizedWarn)('Could not find typescript. Please ensure that typescript is a devDependency. Falling back to compiled source.');
+        (0, warn_1.warn)('Could not find typescript. Please ensure that typescript is a devDependency. Falling back to compiled source.');
         return;
     }
     const read = async (path) => {

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/colorize-json.d.ts

@@ -0,0 +1,28 @@
+type Options = {
+    pretty?: boolean;
+    theme?: Record<string, string>;
+};
+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,64 @@
+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 declare const methods: {
+    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;
+};
+export default methods;