@appium/support
Version:
Support libs used across Appium packages
164 lines • 5.29 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.symbols = exports.console = exports.CliConsole = void 0;
const lodash_1 = __importDefault(require("lodash"));
const supports_color_1 = require("supports-color");
const console_1 = require("console");
require("@colors/colors");
const log_symbols_1 = __importDefault(require("log-symbols"));
exports.symbols = log_symbols_1.default;
const stream_1 = require("stream");
/**
* Stream to nowhere. Used when we want to disable any output other than JSON output.
*/
class NullWritable extends stream_1.Writable {
// eslint-disable-next-line promise/prefer-await-to-callbacks
_write(chunk, encoding, callback) {
setImmediate(callback);
}
}
/**
* A particular console/logging class for Appium's CLI.
*
* - By default, uses some fancy symbols
* - Writes to `STDERR`, generally.
* - In "JSON mode", `STDERR` is squelched. Use {@linkcode Console.json} to write the JSON.
*
* DO NOT extend this to do anything other than what it already does. Download a library or something.
*/
class CliConsole {
/**
* Internal console
* @type {globalThis.Console}
*/
#console;
/**
* Whether or not to use fancy symbols when logging.
* @type {boolean}
*
*/
#useSymbols;
/**
* Whether or not to use color.
*/
#useColor;
/**
* @type {Record<keyof typeof symbols,keyof Extract<import('@colors/colors').Color, 'string'>>}
*/
static symbolToColor = {
success: 'green',
info: 'cyan',
warning: 'yellow',
error: 'red',
};
/**
*
* @param {ConsoleOpts} opts
*/
constructor({ jsonMode = false, useSymbols = true, useColor } = {}) {
this.#console = new console_1.Console(process.stdout, jsonMode ? new NullWritable() : process.stderr);
this.#useSymbols = Boolean(useSymbols);
this.#useColor = Boolean(useColor ?? (0, supports_color_1.supportsColor)(process.stderr));
}
/**
* Wraps a message string in breathtaking fanciness
*
* Returns `undefined` if `msg` is `undefined`.
* @param {string} [msg] - Message to decorate, if anything
* @param {keyof typeof CliConsole['symbolToColor']} [symbol] - Symbol to use
* @returns {string|undefined}
*/
decorate(msg, symbol) {
if (lodash_1.default.isString(msg)) {
let newMsg = /** @type {string} */ (msg);
if (lodash_1.default.isString(symbol) && this.#useSymbols) {
newMsg = `${log_symbols_1.default[symbol]} ${newMsg}`;
if (this.#useColor) {
newMsg = newMsg[CliConsole.symbolToColor[symbol]];
}
}
return newMsg;
}
return msg;
}
/**
* Writes to `STDOUT`. Must be stringifyable.
*
* You probably don't want to call this more than once before exiting (since that will output invalid JSON).
* @param {import('type-fest').JsonValue} value
*/
json(value) {
this.#console.log(JSON.stringify(value));
}
/**
* General logging function.
* @param {string} [message]
* @param {...any} args
*/
log(message, ...args) {
this.#console.error(message, ...args);
}
/**
* A "success" message
* @param {string} [message]
* @param {...any} args
*/
ok(message, ...args) {
this.#console.error(this.decorate(message, 'success'), ...args);
}
/**
* Alias for {@linkcode Console.log}
* @param {string} [message]
* @param {...any} args
*/
debug(message, ...args) {
this.log(message, ...args);
}
/**
* Wraps {@link console.dir}
* @param {any} item
* @param {import('util').InspectOptions} [opts]
*/
dump(item, opts) {
this.#console.dir(item, opts);
}
/**
* An "info" message
* @param {string} [message]
* @param {...any} args
*/
info(message, ...args) {
this.log(this.decorate(message, 'info'), ...args);
}
/**
* A "warning" message
* @param {string} [message]
* @param {...any} args
*/
warn(message, ...args) {
this.log(this.decorate(message, 'warning'), ...args);
}
/**
* An "error" message
* @param {string} [message]
* @param {...any} args
*/
error(message, ...args) {
this.log(this.decorate(message, 'error'), ...args);
}
}
exports.CliConsole = CliConsole;
/**
* Options for {@linkcode CliConsole}.
*
* @typedef ConsoleOpts
* @property {boolean} [jsonMode] - If _truthy_, suppress all output except JSON (use {@linkcode CliConsole#json}), which writes to `STDOUT`.
* @property {boolean} [useSymbols] - If _falsy_, do not use fancy symbols.
* @property {boolean} [useColor] - If _falsy_, do not use color output. If _truthy_, forces color output. By default, checks terminal/TTY for support via pkg `supports-color`. Ignored if `useSymbols` is `false`.
* @see https://npm.im/supports-color
*/
exports.console = new CliConsole();
//# sourceMappingURL=console.js.map