@oclif/core 3.22.0 → 3.23.1

package/lib/cache.js

@@ -22,7 +22,6 @@ class Cache extends Map {
     }
     getOclifCoreMeta() {
         try {
-            // eslint-disable-next-line node/no-extraneous-require
             return { name: '@oclif/core', version: require('@oclif/core/package.json').version };
         }
         catch {

package/lib/cli-ux/action/base.d.ts

@@ -5,6 +5,9 @@ export interface ITask {
     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[]][];

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

@@ -3,6 +3,9 @@ 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/config.d.ts

@@ -5,6 +5,9 @@ export interface ConfigMessage {
     type: 'config';
     value: any;
 }
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
 export declare class Config {
     action: ActionBase;
     errorsHandled: boolean;
@@ -15,5 +18,8 @@ export declare class Config {
     get debug(): boolean;
     set debug(v: boolean);
 }
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
 export declare const config: Config;
 export default config;

package/lib/cli-ux/config.js

@@ -15,6 +15,9 @@ const actionType = (Boolean(process.stderr.isTTY) &&
     'spinner') ||
     'simple';
 const Action = actionType === 'spinner' ? spinner_1.default : simple_1.default;
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
 class Config {
     action = new Action();
     errorsHandled = false;
@@ -42,5 +45,8 @@ function fetch() {
     globals[major] = new Config();
     return globals[major];
 }
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
 exports.config = fetch();
 exports.default = exports.config;

package/lib/cli-ux/flush.js

@@ -21,7 +21,7 @@ async function _flush() {
         return;
     return p;
 }
-async function flush(ms = 10000) {
+async function flush(ms = 10_000) {
     await timeout(_flush(), ms);
 }
 exports.flush = flush;

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

@@ -31,7 +31,99 @@ export declare class ux {
 }
 declare const action: ActionBase, annotation: typeof ux.annotation, anykey: typeof uxPrompt.anykey, confirm: typeof uxPrompt.confirm, debug: typeof ux.debug, done: typeof ux.done, flush: typeof ux.flush, info: typeof ux.info, log: typeof ux.log, logToStderr: typeof ux.logToStderr, progress: typeof styled.progress, prompt: typeof uxPrompt.prompt, styledHeader: typeof ux.styledHeader, styledJSON: typeof ux.styledJSON, styledObject: typeof ux.styledObject, table: typeof styled.Table.table, trace: typeof ux.trace, tree: typeof styled.tree, url: typeof ux.url, wait: (ms?: number) => Promise<void>;
 declare const error: typeof Errors.error, exit: typeof Errors.exit, warn: typeof Errors.warn;
-export { action, annotation, anykey, confirm, debug, done, error, exit, flush, info, log, logToStderr, progress, prompt, styledHeader, styledJSON, styledObject, table, trace, tree, url, wait, warn, };
+export { 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+action, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+annotation, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+anykey, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+confirm, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+debug, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+done, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+error, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+exit, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+flush, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+info, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+log, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+logToStderr, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+progress, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+prompt, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+styledHeader, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+styledJSON, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+styledObject, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+table, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+trace, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+tree, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+url, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+wait, 
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
+warn, };
 export { ActionBase } from './action/base';
 export { Config, config } from './config';
 export { ExitError } from './exit';

package/lib/cli-ux/index.js

@@ -69,7 +69,7 @@ class ux {
     static async done() {
         config_1.config.action.stop();
     }
-    static async flush(ms = 10000) {
+    static async flush(ms = 10_000) {
         await (0, flush_1.flush)(ms);
     }
     static info(format, ...args) {

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

@@ -1,3 +1,6 @@
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
 export interface IPromptOptions {
     default?: string;
     prompt?: string;

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

@@ -37,6 +37,9 @@ const F = __importStar(require("../../flags"));
 const screen_1 = require("../../screen");
 const util_1 = require("../../util/util");
 const write_1 = __importDefault(require("../write"));
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
 class Table {
     data;
     columns;

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

@@ -1,3 +1,6 @@
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
 declare const _default: {
     stderr: (msg: string) => void;
     stdout: (msg: string) => void;

package/lib/cli-ux/write.js

@@ -6,6 +6,9 @@ const stdout = (msg) => {
 const stderr = (msg) => {
     process.stderr.write(msg);
 };
+/**
+ * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
+ */
 exports.default = {
     stderr,
     stdout,

package/lib/errors/handle.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handle = exports.Exit = void 0;
-/* eslint-disable no-process-exit */
 const clean_stack_1 = __importDefault(require("clean-stack"));
 const config_1 = require("./config");
 const cli_1 = require("./errors/cli");
@@ -17,6 +16,7 @@ const pretty_print_1 = __importDefault(require("./errors/pretty-print"));
  */
 exports.Exit = {
     exit(code = 0) {
+        // eslint-disable-next-line n/no-process-exit, unicorn/no-process-exit
         process.exit(code);
     },
 };

package/lib/help/command.js

@@ -295,13 +295,14 @@ class CommandHelp extends formatter_1.HelpFormatter {
     usage() {
         const { id, usage } = this.command;
         const standardId = (0, ids_1.toStandardizedId)(id, this.config);
+        const configuredId = (0, ids_1.toConfiguredId)(id, this.config);
         const body = (usage ? (0, util_1.castArray)(usage) : [this.defaultUsage()])
             .map((u) => {
             const allowedSpacing = this.opts.maxWidth - this.indentSpacing;
             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 commandDescription = (0, theme_1.colorize)(this.config?.theme?.sectionDescription, u.replace('<%= command.id %>', '').replace(standardId, '').replace(configuredId, '').trim());
             const line = `${dollarSign} ${bin} ${command} ${commandDescription}`.trim();
             if (line.length > allowedSpacing) {
                 const splitIndex = line.slice(0, Math.max(0, allowedSpacing)).lastIndexOf(' ');

package/lib/util/find-root.js

@@ -89,7 +89,7 @@ function maybeRequirePnpApi(root) {
     if (pnp)
         return pnp;
     try {
-        // eslint-disable-next-line node/no-missing-require
+        // eslint-disable-next-line n/no-missing-require
         pnp = require(require.resolve('pnpapi', { paths: [root] }));
         return pnp;
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.22.0",
+  "version": "3.23.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -65,10 +65,10 @@
     "commitlint": "^17.8.1",
     "cross-env": "^7.0.3",
     "eslint": "^8.57.0",
-    "eslint-config-oclif": "^5.0.4",
-    "eslint-config-oclif-typescript": "^3.0.48",
+    "eslint-config-oclif": "^5.1.0",
+    "eslint-config-oclif-typescript": "^3.1.0",
     "eslint-config-prettier": "^9.1.0",
-    "fancy-test": "^3.0.11",
+    "fancy-test": "^3.0.12",
     "globby": "^11.1.0",
     "husky": "^8",
     "lint-staged": "^14.0.1",