@oclif/core 3.11.0 → 3.11.1-dev.1

package/lib/cli-ux/index.d.ts

@@ -37,4 +37,5 @@ export { Config, config } from './config';
 export { ExitError } from './exit';
 export { IPromptOptions } from './prompt';
 export { Table } from './styled';
+export { colorize } from './theme';
 export { default as write } from './write';

package/lib/cli-ux/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.write = exports.Table = exports.ExitError = exports.config = exports.Config = exports.ActionBase = exports.warn = exports.wait = exports.url = exports.tree = exports.trace = exports.table = exports.styledObject = exports.styledJSON = exports.styledHeader = exports.prompt = exports.progress = exports.logToStderr = exports.log = exports.info = exports.flush = exports.exit = exports.error = exports.done = exports.debug = exports.confirm = exports.anykey = exports.annotation = exports.action = exports.ux = void 0;
+exports.write = exports.colorize = exports.Table = exports.ExitError = exports.config = exports.Config = exports.ActionBase = exports.warn = exports.wait = exports.url = exports.tree = exports.trace = exports.table = exports.styledObject = exports.styledJSON = exports.styledHeader = exports.prompt = exports.progress = exports.logToStderr = exports.log = exports.info = exports.flush = exports.exit = exports.error = exports.done = exports.debug = exports.confirm = exports.anykey = exports.annotation = exports.action = exports.ux = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const node_util_1 = require("node:util");
 const Errors = __importStar(require("../errors"));
@@ -177,5 +177,7 @@ var exit_1 = require("./exit");
 Object.defineProperty(exports, "ExitError", { enumerable: true, get: function () { return exit_1.ExitError; } });
 var styled_1 = require("./styled");
 Object.defineProperty(exports, "Table", { enumerable: true, get: function () { return styled_1.Table; } });
+var theme_1 = require("./theme");
+Object.defineProperty(exports, "colorize", { enumerable: true, get: function () { return theme_1.colorize; } });
 var write_2 = require("./write");
 Object.defineProperty(exports, "write", { enumerable: true, get: function () { return __importDefault(write_2).default; } });

package/lib/cli-ux/theme.d.ts

@@ -0,0 +1,11 @@
+import { StandardChalk, Theme, Themes } 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 chalk color (e.g. `red`)
+ * @param text string to colorize
+ * @returns colorized string
+ */
+export declare function colorize(color: string | StandardChalk | undefined, text: string): string;
+export declare function parseTheme(theme: Themes): Theme;
+export declare function getColor(color: string): string;
+export declare function getColor(color: StandardChalk): StandardChalk;

package/lib/cli-ux/theme.js

@@ -0,0 +1,63 @@
+"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 });
+exports.getColor = exports.parseTheme = exports.colorize = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const Color = __importStar(require("color"));
+const theme_1 = require("../interfaces/theme");
+function isStandardChalk(color) {
+    return theme_1.STANDARD_CHALK.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 chalk color (e.g. `red`)
+ * @param text string to colorize
+ * @returns colorized string
+ */
+function colorize(color, text) {
+    if (isStandardChalk(color))
+        return chalk_1.default[color](text);
+    return color ? chalk_1.default.hex(color)(text) : text;
+}
+exports.colorize = colorize;
+function parseTheme(theme) {
+    const themes = theme.themes ?? {};
+    const selected = theme.selected ? themes[theme.selected] ?? {} : {};
+    return Object.fromEntries(Object.entries(selected)
+        .map(([key, value]) => [key, getColor(value)])
+        .filter(([_, value]) => value));
+}
+exports.parseTheme = parseTheme;
+function getColor(color) {
+    try {
+        // eslint-disable-next-line new-cap
+        return isStandardChalk(color) ? color : new Color.default(color).hex();
+    }
+    catch { }
+}
+exports.getColor = getColor;

package/lib/command.js

@@ -37,6 +37,7 @@ const util_1 = require("./help/util");
 const Parser = __importStar(require("./parser"));
 const aggregate_flags_1 = require("./util/aggregate-flags");
 const fs_1 = require("./util/fs");
+const ids_1 = require("./util/ids");
 const util_2 = require("./util/util");
 const pjson = (0, fs_1.requireJson)(__dirname, '..', 'package.json');
 /**
@@ -260,12 +261,12 @@ class Command {
     warnIfCommandDeprecated() {
         const [id] = (0, util_1.normalizeArgv)(this.config);
         if (this.ctor.deprecateAliases && this.ctor.aliases.includes(id)) {
-            const cmdName = (0, util_1.toConfiguredId)(this.ctor.id, this.config);
-            const aliasName = (0, util_1.toConfiguredId)(id, this.config);
+            const cmdName = (0, ids_1.toConfiguredId)(this.ctor.id, this.config);
+            const aliasName = (0, ids_1.toConfiguredId)(id, this.config);
             this.warn((0, util_1.formatCommandDeprecationWarning)(aliasName, { to: cmdName }));
         }
         if (this.ctor.state === 'deprecated') {
-            const cmdName = (0, util_1.toConfiguredId)(this.ctor.id, this.config);
+            const cmdName = (0, ids_1.toConfiguredId)(this.ctor.id, this.config);
             this.warn((0, util_1.formatCommandDeprecationWarning)(cmdName, this.ctor.deprecationOptions));
         }
     }

package/lib/config/config.d.ts

@@ -2,6 +2,7 @@ import { Command } from '../command';
 import { Hook, Hooks, PJSON, Topic } from '../interfaces';
 import { ArchTypes, Config as IConfig, LoadOptions, PlatformTypes, VersionDetails } from '../interfaces/config';
 import { Plugin as IPlugin, Options } from '../interfaces/plugin';
+import { Theme, Themes } from '../interfaces/theme';
 export declare class Config implements IConfig {
     options: Options;
     arch: ArchTypes;
@@ -25,6 +26,7 @@ export declare class Config implements IConfig {
     plugins: Map<string, IPlugin>;
     root: string;
     shell: string;
+    theme?: Theme;
     topicSeparator: ' ' | ':';
     userAgent: string;
     userPJSON?: PJSON.User;
@@ -90,6 +92,11 @@ export declare class Config implements IConfig {
     loadPluginsAndCommands(opts?: {
         force: boolean;
     }): Promise<void>;
+    loadThemes(): Promise<{
+        file: string;
+        activeTheme: Theme | undefined;
+        themes: Themes | undefined;
+    }>;
     protected macosCacheDir(): string | undefined;
     runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable | null): Promise<T>;
     runHook<T extends keyof Hooks>(event: T, opts: Hooks[T]['options'], timeout?: number, captureErrors?: boolean): Promise<Hook.Result<Hooks[T]['return']>>;

package/lib/config/config.js

@@ -33,6 +33,7 @@ const node_os_1 = require("node:os");
 const node_path_1 = require("node:path");
 const node_url_1 = require("node:url");
 const cli_ux_1 = require("../cli-ux");
+const theme_1 = require("../cli-ux/theme");
 const errors_1 = require("../errors");
 const util_1 = require("../help/util");
 const module_loader_1 = require("../module-loader");
@@ -105,6 +106,7 @@ class Config {
     plugins = new Map();
     root;
     shell;
+    theme;
     topicSeparator = ':';
     userAgent;
     userPJSON;
@@ -296,6 +298,10 @@ class Config {
         this.errlog = (0, node_path_1.join)(this.cacheDir, 'error.log');
         this.binPath = this.scopedEnvVar('BINPATH');
         this.npmRegistry = this.scopedEnvVar('NPM_REGISTRY') || this.pjson.oclif.npmRegistry;
+        if (!this.scopedEnvVarTrue('DISABLE_THEME')) {
+            const { activeTheme } = await this.loadThemes();
+            this.theme = activeTheme;
+        }
         this.pjson.oclif.update = this.pjson.oclif.update || {};
         this.pjson.oclif.update.node = this.pjson.oclif.update.node || {};
         const s3 = this.pjson.oclif.update.s3 || {};
@@ -351,6 +357,18 @@ class Config {
             this.warn(error);
         }
     }
+    async loadThemes() {
+        const themesFile = this.pjson.oclif.themesFile
+            ? (0, node_path_1.resolve)(this.root, this.pjson.oclif.themesFile)
+            : (0, node_path_1.resolve)(this.configDir, 'themes.json');
+        const themes = await (0, fs_1.safeReadJson)(themesFile);
+        const activeTheme = themes ? (0, theme_1.parseTheme)(themes) : undefined;
+        return {
+            activeTheme,
+            file: themesFile,
+            themes,
+        };
+    }
     macosCacheDir() {
         return (this.platform === 'darwin' && (0, node_path_1.join)(this.home, 'Library', 'Caches', this.dirname)) || undefined;
     }
@@ -537,7 +555,7 @@ class Config {
             .map((alias) => [alias.replaceAll('@', '').replaceAll(/[/-]/g, '_'), k].join('_').toUpperCase());
     }
     scopedEnvVarTrue(k) {
-        const v = process.env[this.scopedEnvVarKeys(k).find((k) => process.env[k])];
+        const v = this.scopedEnvVar(k);
         return v === '1' || v === 'true';
     }
     warn(err, scope) {

package/lib/help/command.js

@@ -6,7 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandHelp = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
+const theme_1 = require("../cli-ux/theme");
 const ensure_arg_object_1 = require("../util/ensure-arg-object");
+const ids_1 = require("../util/ids");
 const util_1 = require("../util/util");
 const docopts_1 = require("./docopts");
 const formatter_1 = require("./formatter");
@@ -14,11 +16,6 @@ const formatter_1 = require("./formatter");
 // written on any platform, that may use \r\n or \n, will be
 // split on any platform, not just the os specific EOL at runtime.
 const POSSIBLE_LINE_FEED = /\r\n|\n/;
-let { dim } = chalk_1.default;
-if (process.env.ConEmuANSI === 'ON') {
-    // eslint-disable-next-line unicorn/consistent-destructuring
-    dim = chalk_1.default.gray;
-}
 class CommandHelp extends formatter_1.HelpFormatter {
     command;
     config;
@@ -32,7 +29,13 @@ class CommandHelp extends formatter_1.HelpFormatter {
     aliases(aliases) {
         if (!aliases || aliases.length === 0)
             return;
-        const body = aliases.map((a) => ['$', this.config.bin, a].join(' ')).join('\n');
+        const body = aliases
+            .map((a) => [
+            (0, theme_1.colorize)(this.config?.theme?.dollarSign, '$'),
+            (0, theme_1.colorize)(this.config?.theme?.bin, this.config.bin),
+            (0, theme_1.colorize)(this.config?.theme?.alias, a),
+        ].join(' '))
+            .join('\n');
         return body;
     }
     arg(arg) {
@@ -48,10 +51,13 @@ class CommandHelp extends formatter_1.HelpFormatter {
             const name = a.name.toUpperCase();
             let description = a.description || '';
             if (a.default)
-                description = `[default: ${a.default}] ${description}`;
+                description = `${(0, theme_1.colorize)(this.config?.theme?.flagDefaultValue, `[default: ${a.default}]`)} ${description}`;
             if (a.options)
-                description = `(${a.options.join('|')}) ${description}`;
-            return [name, description ? dim(description) : undefined];
+                description = `${(0, theme_1.colorize)(this.config?.theme?.flagOptions, `(${a.options.join('|')})`)} ${description}`;
+            return [
+                (0, theme_1.colorize)(this.config?.theme?.flag, name),
+                description ? (0, theme_1.colorize)(this.config?.theme?.sectionDescription, description) : undefined,
+            ];
         });
     }
     defaultUsage() {
@@ -134,7 +140,7 @@ class CommandHelp extends formatter_1.HelpFormatter {
                     labels.push(`--${flag.name.trim()}`);
                 }
             }
-            label = labels.join(flag.char ? ', ' : '  ');
+            label = labels.join((0, theme_1.colorize)(this.config?.theme?.flagSeparator, flag.char ? ', ' : '  '));
         }
         if (flag.type === 'option') {
             let value = flag.helpValue || (this.opts.showFlagNameInTitle ? flag.name : '<value>');
@@ -154,19 +160,19 @@ class CommandHelp extends formatter_1.HelpFormatter {
             return;
         const noChar = flags.reduce((previous, current) => previous && current.char === undefined, true);
         return flags.map((flag) => {
-            let left = this.flagHelpLabel(flag);
+            let left = (0, theme_1.colorize)(this.config?.theme?.flag, this.flagHelpLabel(flag));
             if (noChar)
                 left = left.replace('    ', '');
             let right = flag.summary || flag.description || '';
             if (flag.type === 'option' && flag.default) {
-                right = `[default: ${flag.default}] ${right}`;
+                right = `${(0, theme_1.colorize)(this.config?.theme?.flagDefaultValue, `[default: ${flag.default}]`)} ${right}`;
             }
             if (flag.required)
-                right = `(required) ${right}`;
+                right = `${(0, theme_1.colorize)(this.config?.theme?.flagRequired, '(required)')} ${right}`;
             if (flag.type === 'option' && flag.options && !flag.helpValue && !this.opts.showFlagOptionsInTitle) {
-                right += `\n<options: ${flag.options.join('|')}>`;
+                right += (0, theme_1.colorize)(this.config?.theme?.flagOptions, `\n<options: ${flag.options.join('|')}>`);
             }
-            return [left, dim(right.trim())];
+            return [left, (0, theme_1.colorize)(this.config?.theme?.sectionDescription, right.trim())];
         });
     }
     flagsDescriptions(flags) {
@@ -274,11 +280,16 @@ class CommandHelp extends formatter_1.HelpFormatter {
         ];
     }
     usage() {
-        const { usage } = this.command;
+        const { id, usage } = this.command;
+        const standardId = (0, ids_1.toStandardizedId)(id, this.config);
         const body = (usage ? (0, util_1.castArray)(usage) : [this.defaultUsage()])
             .map((u) => {
             const allowedSpacing = this.opts.maxWidth - this.indentSpacing;
-            const line = `$ ${this.config.bin} ${u}`.trim();
+            const dollarSign = (0, theme_1.colorize)(this.config?.theme?.dollarSign, '$');
+            const bin = (0, theme_1.colorize)(this.config?.theme?.bin, this.config.bin);
+            const command = (0, theme_1.colorize)(this.config?.theme?.command, '<%= command.id %>');
+            const commandDescription = (0, theme_1.colorize)(this.config?.theme?.sectionDescription, u.replace('<%= command.id %>', '').replace(standardId, '').trim());
+            const line = `${dollarSign} ${bin} ${command} ${commandDescription}`.trim();
             if (line.length > allowedSpacing) {
                 const splitIndex = line.slice(0, Math.max(0, allowedSpacing)).lastIndexOf(' ');
                 return (line.slice(0, Math.max(0, splitIndex)) +
@@ -292,14 +303,15 @@ class CommandHelp extends formatter_1.HelpFormatter {
     }
     formatIfCommand(example) {
         example = this.render(example);
+        const dollarSign = (0, theme_1.colorize)(this.config?.theme?.dollarSign, '$');
         if (example.startsWith(this.config.bin))
-            return dim(`$ ${example}`);
+            return `${dollarSign} ${example}`;
         if (example.startsWith(`$ ${this.config.bin}`))
-            return dim(example);
+            return `${dollarSign}${example.replace(`$`, '')}`;
         return example;
     }
     isCommand(example) {
-        return (0, strip_ansi_1.default)(this.formatIfCommand(example)).startsWith(`$ ${this.config.bin}`);
+        return (0, strip_ansi_1.default)(this.formatIfCommand(example)).startsWith(`${(0, theme_1.colorize)(this.config?.theme?.dollarSign, '$')} ${this.config.bin}`);
     }
 }
 exports.CommandHelp = CommandHelp;

package/lib/help/formatter.js

@@ -10,6 +10,7 @@ const string_width_1 = __importDefault(require("string-width"));
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
 const widest_line_1 = __importDefault(require("widest-line"));
 const wrap_ansi_1 = __importDefault(require("wrap-ansi"));
+const theme_1 = require("../cli-ux/theme");
 const screen_1 = require("../screen");
 const util_1 = require("./util");
 class HelpFormatter {
@@ -154,8 +155,8 @@ class HelpFormatter {
                 .map(([left, right]) => [this.render(left), right && this.render(right)]);
         }
         const output = [
-            chalk_1.default.bold(header),
-            this.indent(Array.isArray(newBody) ? this.renderList(newBody, { indentation: 2, stripAnsi: this.opts.stripAnsi }) : newBody),
+            (0, theme_1.colorize)(this.config?.theme?.sectionHeader, chalk_1.default.bold(header)),
+            (0, theme_1.colorize)(this.config?.theme?.sectionDescription, this.indent(Array.isArray(newBody) ? this.renderList(newBody, { indentation: 2, stripAnsi: this.opts.stripAnsi }) : newBody)),
         ].join('\n');
         return this.opts.stripAnsi ? (0, strip_ansi_1.default)(output) : output;
     }

package/lib/help/index.js

@@ -6,10 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadHelpClass = exports.Help = exports.HelpBase = exports.standardizeIDFromArgv = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.CommandHelp = void 0;
 const node_util_1 = require("node:util");
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
+const theme_1 = require("../cli-ux/theme");
 const write_1 = __importDefault(require("../cli-ux/write"));
 const errors_1 = require("../errors");
 const module_loader_1 = require("../module-loader");
 const cache_default_value_1 = require("../util/cache-default-value");
+const ids_1 = require("../util/ids");
 const util_1 = require("../util/util");
 const command_1 = require("./command");
 const formatter_1 = require("./formatter");
@@ -87,7 +89,11 @@ class Help extends HelpBase {
             .map((c) => {
             if (this.config.topicSeparator !== ':')
                 c.id = c.id.replaceAll(':', this.config.topicSeparator);
-            return [c.id, this.summary(c)];
+            const summary = this.summary(c);
+            return [
+                (0, theme_1.colorize)(this.config?.theme?.command, c.id),
+                summary && (0, theme_1.colorize)(this.config?.theme?.sectionDescription, (0, strip_ansi_1.default)(summary)),
+            ];
         }), {
             indentation: 2,
             spacer: '\n',
@@ -107,9 +113,10 @@ class Help extends HelpBase {
         if (this.config.topicSeparator !== ':')
             topicID = topicID.replaceAll(':', this.config.topicSeparator);
         let output = (0, util_1.compact)([
-            summary,
-            this.section(this.opts.usageHeader || 'USAGE', `$ ${this.config.bin} ${topicID}`),
-            description && this.section('DESCRIPTION', this.wrap(description)),
+            (0, theme_1.colorize)(this.config?.theme?.commandSummary, summary),
+            this.section(this.opts.usageHeader || 'USAGE', `${(0, theme_1.colorize)(this.config?.theme?.dollarSign, '$')} ${(0, theme_1.colorize)(this.config?.theme?.bin, this.config.bin)} ${topicID}`),
+            description &&
+                this.section('DESCRIPTION', this.wrap((0, theme_1.colorize)(this.config?.theme?.sectionDescription, description))),
         ]).join('\n\n');
         if (this.opts.stripAnsi)
             output = (0, strip_ansi_1.default)(output);
@@ -121,7 +128,10 @@ class Help extends HelpBase {
         const body = this.renderList(topics.map((c) => {
             if (this.config.topicSeparator !== ':')
                 c.name = c.name.replaceAll(':', this.config.topicSeparator);
-            return [c.name, c.description && this.render(c.description.split('\n')[0])];
+            return [
+                (0, theme_1.colorize)(this.config?.theme?.topic, c.name),
+                c.description && this.render((0, theme_1.colorize)(this.config?.theme?.sectionDescription, c.description.split('\n')[0])),
+            ];
         }), {
             indentation: 2,
             spacer: '\n',
@@ -144,13 +154,13 @@ class Help extends HelpBase {
         const state = this.config.pjson?.oclif?.state || plugin?.pjson?.oclif?.state || command.state;
         if (state) {
             this.log(state === 'deprecated'
-                ? `${(0, util_2.formatCommandDeprecationWarning)((0, util_2.toConfiguredId)(name, this.config), command.deprecationOptions)}\n`
+                ? `${(0, util_2.formatCommandDeprecationWarning)((0, ids_1.toConfiguredId)(name, this.config), command.deprecationOptions)}\n`
                 : `This command is in ${state}.\n`);
         }
         if (command.deprecateAliases && command.aliases.includes(name)) {
             const actualCmd = this.config.commands.find((c) => c.aliases.includes(name));
             const opts = { ...command.deprecationOptions, ...(actualCmd ? { to: actualCmd.id } : {}) };
-            this.log(`${(0, util_2.formatCommandDeprecationWarning)((0, util_2.toConfiguredId)(name, this.config), opts)}\n`);
+            this.log(`${(0, util_2.formatCommandDeprecationWarning)((0, ids_1.toConfiguredId)(name, this.config), opts)}\n`);
         }
         const summary = this.summary(command);
         if (summary) {
@@ -274,8 +284,8 @@ class Help extends HelpBase {
     }
     summary(c) {
         if (c.summary)
-            return this.render(c.summary.split('\n')[0]);
-        return c.description && this.render(c.description).split('\n')[0];
+            return (0, theme_1.colorize)(this.config?.theme?.commandSummary, this.render(c.summary.split('\n')[0]));
+        return c.description && (0, theme_1.colorize)(this.config?.theme?.commandSummary, this.render(c.description).split('\n')[0]);
     }
     /*
      * _topics is to work around Interfaces.topics mistakenly including commands that do

package/lib/help/root.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
+const theme_1 = require("../cli-ux/theme");
 const util_1 = require("../util/util");
 const formatter_1 = require("./formatter");
 class RootHelp extends formatter_1.HelpFormatter {
@@ -20,22 +21,27 @@ class RootHelp extends formatter_1.HelpFormatter {
         description = description.split('\n').slice(1).join('\n');
         if (!description)
             return;
-        return this.section('DESCRIPTION', this.wrap(description));
+        return this.section('DESCRIPTION', this.wrap((0, theme_1.colorize)(this.config?.theme?.sectionDescription, description)));
     }
     root() {
         let description = this.config.pjson.oclif.description || this.config.pjson.description || '';
         description = this.render(description);
         description = description.split('\n')[0];
-        let output = (0, util_1.compact)([description, this.version(), this.usage(), this.description()]).join('\n\n');
+        let output = (0, util_1.compact)([
+            (0, theme_1.colorize)(this.config?.theme?.commandSummary, description),
+            this.version(),
+            this.usage(),
+            this.description(),
+        ]).join('\n\n');
         if (this.opts.stripAnsi)
             output = (0, strip_ansi_1.default)(output);
         return output;
     }
     usage() {
-        return this.section(this.opts.usageHeader || 'USAGE', this.wrap(`$ ${this.config.bin} [COMMAND]`));
+        return this.section(this.opts.usageHeader || 'USAGE', this.wrap(`${(0, theme_1.colorize)(this.config?.theme?.dollarSign, '$')} ${(0, theme_1.colorize)(this.config?.theme?.bin, this.config.bin)} ${(0, theme_1.colorize)(this.config?.theme?.sectionDescription, '[COMMAND]')}`));
     }
     version() {
-        return this.section('VERSION', this.wrap(this.config.userAgent));
+        return this.section('VERSION', this.wrap((0, theme_1.colorize)(this.config?.theme?.version, this.config.userAgent)));
     }
 }
 exports.default = RootHelp;

package/lib/help/util.d.ts

@@ -1,7 +1,5 @@
 import { Deprecation, Config as IConfig } from '../interfaces';
 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[];
 export declare function getHelpFlagAdditions(config: IConfig): string[];
 export declare function formatFlagDeprecationWarning(flag: string, opts: Deprecation | true): string;

package/lib/help/util.js

@@ -23,9 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeArgv = exports.formatCommandDeprecationWarning = exports.formatFlagDeprecationWarning = exports.getHelpFlagAdditions = exports.standardizeIDFromArgv = exports.toConfiguredId = exports.toStandardizedId = exports.template = void 0;
+exports.normalizeArgv = exports.formatCommandDeprecationWarning = exports.formatFlagDeprecationWarning = exports.getHelpFlagAdditions = exports.standardizeIDFromArgv = exports.template = void 0;
 const ejs = __importStar(require("ejs"));
 const util_1 = require("../config/util");
+const ids_1 = require("../util/ids");
 function template(context) {
     function render(t) {
         return ejs.render(t, context);
@@ -69,22 +70,13 @@ function collateSpacedCmdIDFromArgs(argv, config) {
     }
     return argv; // ID is argv[0]
 }
-function toStandardizedId(commandID, config) {
-    return commandID.replaceAll(new RegExp(config.topicSeparator, 'g'), ':');
-}
-exports.toStandardizedId = toStandardizedId;
-function toConfiguredId(commandID, config) {
-    const defaultTopicSeparator = ':';
-    return commandID.replaceAll(new RegExp(defaultTopicSeparator, 'g'), config.topicSeparator || defaultTopicSeparator);
-}
-exports.toConfiguredId = toConfiguredId;
 function standardizeIDFromArgv(argv, config) {
     if (argv.length === 0)
         return argv;
     if (config.topicSeparator === ' ')
         argv = collateSpacedCmdIDFromArgs(argv, config);
     else if (config.topicSeparator !== ':')
-        argv[0] = toStandardizedId(argv[0], config);
+        argv[0] = (0, ids_1.toStandardizedId)(argv[0], config);
     return argv;
 }
 exports.standardizeIDFromArgv = standardizeIDFromArgv;

package/lib/index.d.ts

@@ -10,7 +10,6 @@ export { execute } from './execute';
 export * as Flags from './flags';
 export { CommandHelp, Help, HelpBase, loadHelpClass } from './help';
 export { HelpSection, HelpSectionKeyValueTable, HelpSectionRenderer } from './help/formatter';
-export { toConfiguredId, toStandardizedId } from './help/util';
 export * as Interfaces from './interfaces';
 export { Hook } from './interfaces/hooks';
 export { run } from './main';
@@ -18,3 +17,4 @@ export * as ModuleLoader from './module-loader';
 export * as Parser from './parser';
 export { Performance } from './performance';
 export { Settings, settings } from './settings';
+export { toConfiguredId, toStandardizedId } from './util/ids';

package/lib/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.settings = exports.Performance = exports.Parser = exports.ModuleLoader = exports.run = exports.Interfaces = exports.toStandardizedId = exports.toConfiguredId = 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;
+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"));
 function checkCWD() {
     try {
@@ -43,8 +43,7 @@ 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; } });
-// Remove these in the next major version
-var stream_1 = require("./cli-ux/stream");
+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");
@@ -63,9 +62,6 @@ Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function
 Object.defineProperty(exports, "Help", { enumerable: true, get: function () { return help_1.Help; } });
 Object.defineProperty(exports, "HelpBase", { enumerable: true, get: function () { return help_1.HelpBase; } });
 Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return help_1.loadHelpClass; } });
-var util_1 = require("./help/util");
-Object.defineProperty(exports, "toConfiguredId", { enumerable: true, get: function () { return util_1.toConfiguredId; } });
-Object.defineProperty(exports, "toStandardizedId", { enumerable: true, get: function () { return util_1.toStandardizedId; } });
 exports.Interfaces = __importStar(require("./interfaces"));
 var main_1 = require("./main");
 Object.defineProperty(exports, "run", { enumerable: true, get: function () { return main_1.run; } });
@@ -75,3 +71,6 @@ var performance_1 = require("./performance");
 Object.defineProperty(exports, "Performance", { enumerable: true, get: function () { return performance_1.Performance; } });
 var settings_1 = require("./settings");
 Object.defineProperty(exports, "settings", { enumerable: true, get: function () { return settings_1.settings; } });
+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; } });

package/lib/interfaces/config.d.ts

@@ -3,6 +3,7 @@ import { Command } from '../command';
 import { Hook, Hooks } from './hooks';
 import { PJSON } from './pjson';
 import { Options, Plugin } from './plugin';
+import { Theme } from './theme';
 import { Topic } from './topic';
 export type LoadOptions = Config | Options | string | undefined;
 export type PlatformTypes = 'wsl' | NodeJS.Platform;
@@ -121,6 +122,7 @@ export interface Config {
      * active shell
      */
     readonly shell: string;
+    readonly theme?: Theme;
     topicSeparator: ' ' | ':';
     readonly topics: Topic[];
     /**

package/lib/interfaces/index.d.ts

@@ -10,5 +10,6 @@ export type { Arg, BooleanFlag, CustomOptions, Deprecation, Flag, FlagDefinition
 export type { PJSON } from './pjson';
 export type { Options, Plugin, PluginOptions } from './plugin';
 export type { S3Manifest } from './s3-manifest';
+export type { Theme, Themes } from './theme';
 export type { Topic } from './topic';
 export type { TSConfig } from './ts-config';

package/lib/interfaces/pjson.d.ts

@@ -49,6 +49,7 @@ export declare namespace PJSON {
             repositoryPrefix?: string;
             schema?: number;
             state?: 'beta' | 'deprecated' | string;
+            themesFile?: string;
             topicSeparator?: ' ' | ':';
             topics?: {
                 [k: string]: {

package/lib/interfaces/theme.d.ts

@@ -0,0 +1,26 @@
+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", "flagType", "sectionDescription", "sectionHeader", "topic", "version"];
+export type ThemeKey = (typeof THEME_KEYS)[number];
+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;
+    flagType?: string | StandardChalk;
+    sectionDescription?: string | StandardChalk;
+    sectionHeader?: string | StandardChalk;
+    topic?: string | StandardChalk;
+    version?: string | StandardChalk;
+};
+export type Themes = {
+    selected?: string;
+    themes?: Record<string, Record<string, string>>;
+};

package/lib/interfaces/theme.js

@@ -0,0 +1,62 @@
+"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 = [
+    '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',
+];
+exports.THEME_KEYS = [
+    'alias',
+    'bin',
+    'command',
+    'commandSummary',
+    'dollarSign',
+    'flag',
+    'flagDefaultValue',
+    'flagOptions',
+    'flagRequired',
+    'flagSeparator',
+    'flagType',
+    'sectionDescription',
+    'sectionHeader',
+    'topic',
+    'version',
+];

package/lib/util/ids.d.ts

@@ -0,0 +1,3 @@
+import { Config } from '../interfaces';
+export declare function toStandardizedId(commandID: string, config: Config): string;
+export declare function toConfiguredId(commandID: string, config: Config): string;

package/lib/util/ids.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toConfiguredId = exports.toStandardizedId = void 0;
+function toStandardizedId(commandID, config) {
+    return commandID.replaceAll(new RegExp(config.topicSeparator, 'g'), ':');
+}
+exports.toStandardizedId = toStandardizedId;
+function toConfiguredId(commandID, config) {
+    const defaultTopicSeparator = ':';
+    return commandID.replaceAll(new RegExp(defaultTopicSeparator, 'g'), config.topicSeparator || defaultTopicSeparator);
+}
+exports.toConfiguredId = toConfiguredId;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.11.0",
+  "version": "3.11.1-dev.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -11,6 +11,7 @@
     "chalk": "^4.1.2",
     "clean-stack": "^3.0.1",
     "cli-progress": "^3.12.0",
+    "color": "^4.2.3",
     "debug": "^4.3.4",
     "ejs": "^3.1.9",
     "get-package-type": "^0.1.0",
@@ -44,7 +45,8 @@
     "@types/chai-as-promised": "^7.1.8",
     "@types/clean-stack": "^2.1.1",
     "@types/cli-progress": "^3.11.0",
-    "@types/debug": "^4.1.12",
+    "@types/color": "^3.0.5",
+    "@types/debug": "^4.1.10",
     "@types/ejs": "^3.1.3",
     "@types/indent-string": "^4.0.1",
     "@types/js-yaml": "^3.12.7",
@@ -107,6 +109,7 @@
     "access": "public"
   },
   "scripts": {
+    "build:dev": "shx rm -rf lib && tsc --sourceMap",
     "build": "shx rm -rf lib && tsc",
     "commitlint": "commitlint",
     "compile": "tsc",
@@ -117,9 +120,11 @@
     "prepare": "husky install",
     "pretest": "yarn build && tsc -p test --noEmit --skipLibCheck",
     "test:circular-deps": "madge lib/ -c",
+    "test:debug": "nyc mocha --debug-brk --inspect \"test/**/*.test.ts\"",
     "test:e2e": "mocha --forbid-only \"test/**/*.e2e.ts\" --parallel --timeout 1200000",
     "test:esm-cjs": "cross-env DEBUG=e2e:* ts-node test/integration/esm-cjs.ts",
     "test:perf": "ts-node test/perf/parser.perf.ts",
+    "test:dev": "nyc mocha \"test/**/*.test.ts\"",
     "test": "nyc mocha --forbid-only \"test/**/*.test.ts\""
   },
   "types": "lib/index.d.ts"