@oclif/core 3.26.4 → 4.0.0-beta.2

package/lib/ux/index.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.methods = 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");
+const ACTION_TYPE = (Boolean(process.stderr.isTTY) &&
+    !process.env.CI &&
+    !['dumb', 'emacs-color'].includes(process.env.TERM) &&
+    'spinner') ||
+    'simple';
+exports.methods = {
+    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,
+};
+exports.default = exports.methods;

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>): 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;

package/package.json

@@ -1,83 +1,61 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.26.4",
+  "version": "4.0.0-beta.2",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
-    "@types/cli-progress": "^3.11.5",
     "ansi-escapes": "^4.3.2",
-    "ansi-styles": "^4.3.0",
-    "cardinal": "^2.1.1",
-    "chalk": "^4.1.2",
+    "ansis": "^3.0.1",
     "clean-stack": "^3.0.1",
-    "cli-progress": "^3.12.0",
-    "color": "^4.2.3",
+    "cli-spinners": "^2.9.2",
     "debug": "^4.3.4",
     "ejs": "^3.1.10",
     "get-package-type": "^0.1.0",
     "globby": "^11.1.0",
-    "hyperlinker": "^1.0.0",
     "indent-string": "^4.0.0",
     "is-wsl": "^2.2.0",
-    "js-yaml": "^3.14.1",
     "minimatch": "^9.0.4",
-    "natural-orderby": "^2.0.3",
-    "object-treeify": "^1.1.33",
-    "password-prompt": "^1.1.3",
-    "slice-ansi": "^4.0.0",
     "string-width": "^4.2.3",
-    "strip-ansi": "^6.0.1",
-    "supports-color": "^8.1.1",
-    "supports-hyperlinks": "^2.2.0",
     "widest-line": "^3.1.0",
     "wordwrap": "^1.0.0",
     "wrap-ansi": "^7.0.0"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^17.8.1",
+    "@commitlint/config-conventional": "^19",
     "@oclif/plugin-help": "^6",
-    "@oclif/plugin-plugins": "^4",
+    "@oclif/plugin-plugins": "^5",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^3.2.9",
-    "@types/ansi-styles": "^3.2.1",
     "@types/benchmark": "^2.1.5",
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
     "@types/clean-stack": "^2.1.1",
-    "@types/color": "^3.0.6",
     "@types/debug": "^4.1.10",
     "@types/ejs": "^3.1.5",
     "@types/indent-string": "^4.0.1",
-    "@types/js-yaml": "^3.12.7",
     "@types/mocha": "^10.0.6",
     "@types/node": "^18",
-    "@types/node-notifier": "^8.0.5",
     "@types/pnpapi": "^0.0.5",
-    "@types/slice-ansi": "^4.0.0",
-    "@types/strip-ansi": "^5.2.1",
-    "@types/supports-color": "^8.1.1",
+    "@types/sinon": "^17.0.3",
     "@types/wordwrap": "^1.0.3",
     "@types/wrap-ansi": "^3.0.0",
     "benchmark": "^2.1.4",
     "chai": "^4.4.1",
     "chai-as-promised": "^7.1.1",
-    "commitlint": "^17.8.1",
+    "commitlint": "^19",
     "cross-env": "^7.0.3",
     "eslint": "^8.57.0",
     "eslint-config-oclif": "^5.1.1",
     "eslint-config-oclif-typescript": "^3.1.4",
     "eslint-config-prettier": "^9.1.0",
-    "fancy-test": "^3.0.14",
-    "globby": "^11.1.0",
-    "husky": "^8",
-    "lint-staged": "^14.0.1",
+    "husky": "^9",
+    "lint-staged": "^15",
     "madge": "^6.1.0",
     "mocha": "^10.4.0",
     "nyc": "^15.1.0",
     "prettier": "^3.2.5",
     "shx": "^0.3.4",
-    "sinon": "^16.1.3",
+    "sinon": "^17",
     "ts-node": "^10.9.2",
     "tsd": "^0.31.0",
     "typescript": "^5"
@@ -122,7 +100,7 @@
     "lint": "eslint . --ext .ts",
     "posttest": "yarn lint && yarn test:circular-deps",
     "prepack": "yarn run build",
-    "prepare": "husky install",
+    "prepare": "husky",
     "pretest": "yarn build && tsc -p test --noEmit --skipLibCheck",
     "test:circular-deps": "madge lib/ -c",
     "test:debug": "nyc mocha --debug-brk --inspect \"test/**/*.test.ts\"",

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

@@ -1,251 +0,0 @@
-declare const _default: {
-    arc: {
-        frames: string[];
-        interval: number;
-    };
-    arrow: {
-        frames: string[];
-        interval: number;
-    };
-    arrow2: {
-        frames: string[];
-        interval: number;
-    };
-    arrow3: {
-        frames: string[];
-        interval: number;
-    };
-    balloon: {
-        frames: string[];
-        interval: number;
-    };
-    balloon2: {
-        frames: string[];
-        interval: number;
-    };
-    bounce: {
-        frames: string[];
-        interval: number;
-    };
-    bouncingBall: {
-        frames: string[];
-        interval: number;
-    };
-    bouncingBar: {
-        frames: string[];
-        interval: number;
-    };
-    boxBounce: {
-        frames: string[];
-        interval: number;
-    };
-    boxBounce2: {
-        frames: string[];
-        interval: number;
-    };
-    circle: {
-        frames: string[];
-        interval: number;
-    };
-    circleHalves: {
-        frames: string[];
-        interval: number;
-    };
-    circleQuarters: {
-        frames: string[];
-        interval: number;
-    };
-    clock: {
-        frames: string[];
-        interval: number;
-    };
-    dots: {
-        frames: string[];
-        interval: number;
-    };
-    dots2: {
-        frames: string[];
-        interval: number;
-    };
-    dots3: {
-        frames: string[];
-        interval: number;
-    };
-    dots4: {
-        frames: string[];
-        interval: number;
-    };
-    dots5: {
-        frames: string[];
-        interval: number;
-    };
-    dots6: {
-        frames: string[];
-        interval: number;
-    };
-    dots7: {
-        frames: string[];
-        interval: number;
-    };
-    dots8: {
-        frames: string[];
-        interval: number;
-    };
-    dots9: {
-        frames: string[];
-        interval: number;
-    };
-    dots10: {
-        frames: string[];
-        interval: number;
-    };
-    dots11: {
-        frames: string[];
-        interval: number;
-    };
-    earth: {
-        frames: string[];
-        interval: number;
-    };
-    flip: {
-        frames: string[];
-        interval: number;
-    };
-    growHorizontal: {
-        frames: string[];
-        interval: number;
-    };
-    growVertical: {
-        frames: string[];
-        interval: number;
-    };
-    hamburger: {
-        frames: string[];
-        interval: number;
-    };
-    hearts: {
-        frames: string[];
-        interval: number;
-    };
-    hexagon: {
-        frames: string[];
-        interval: number;
-    };
-    line: {
-        frames: string[];
-        interval: number;
-    };
-    line2: {
-        frames: string[];
-        interval: number;
-    };
-    monkey: {
-        frames: string[];
-        interval: number;
-    };
-    moon: {
-        frames: string[];
-        interval: number;
-    };
-    noise: {
-        frames: string[];
-        interval: number;
-    };
-    pipe: {
-        frames: string[];
-        interval: number;
-    };
-    pong: {
-        frames: string[];
-        interval: number;
-    };
-    runner: {
-        frames: string[];
-        interval: number;
-    };
-    simpleDots: {
-        frames: string[];
-        interval: number;
-    };
-    simpleDotsScrolling: {
-        frames: string[];
-        interval: number;
-    };
-    smiley: {
-        frames: string[];
-        interval: number;
-    };
-    squareCorners: {
-        frames: string[];
-        interval: number;
-    };
-    squish: {
-        frames: string[];
-        interval: number;
-    };
-    star: {
-        frames: string[];
-        interval: number;
-    };
-    star2: {
-        frames: string[];
-        interval: number;
-    };
-    toggle: {
-        frames: string[];
-        interval: number;
-    };
-    toggle2: {
-        frames: string[];
-        interval: number;
-    };
-    toggle3: {
-        frames: string[];
-        interval: number;
-    };
-    toggle4: {
-        frames: string[];
-        interval: number;
-    };
-    toggle5: {
-        frames: string[];
-        interval: number;
-    };
-    toggle6: {
-        frames: string[];
-        interval: number;
-    };
-    toggle7: {
-        frames: string[];
-        interval: number;
-    };
-    toggle8: {
-        frames: string[];
-        interval: number;
-    };
-    toggle9: {
-        frames: string[];
-        interval: number;
-    };
-    toggle10: {
-        frames: string[];
-        interval: number;
-    };
-    toggle11: {
-        frames: string[];
-        interval: number;
-    };
-    toggle12: {
-        frames: string[];
-        interval: number;
-    };
-    toggle13: {
-        frames: string[];
-        interval: number;
-    };
-    triangle: {
-        frames: string[];
-        interval: number;
-    };
-};
-export default _default;