flex-plugins-utils-logger - npm Package Compare versions

Comparing version 0.19.0 to 4.5.1-dev.202103291654

dist/index.js

 "use strict";
+/* eslint-disable import/no-unused-modules */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -17,8 +18,11 @@ if (k2 === undefined) k2 = k;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    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.boxen = void 0;
+exports.boxen = exports.columnify = exports.choose = exports.prompt = exports.confirm = exports.inquirer = exports.progress = exports.printObjectArray = exports.printArray = exports.table = exports.singleLineString = exports.multilineString = exports.strings = exports.logger = exports.coloredStrings = exports.Logger = void 0;
 var _boxen = __importStar(require("./lib/boxen"));
@@ -36,15 +40,15 @@ var boxen = {
 var logger_2 = require("./lib/logger");
-Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_2.default; } });
+Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return __importDefault(logger_2).default; } });
 var strings_1 = require("./lib/strings");
-Object.defineProperty(exports, "strings", { enumerable: true, get: function () { return strings_1.default; } });
+Object.defineProperty(exports, "strings", { enumerable: true, get: function () { return __importDefault(strings_1).default; } });
 Object.defineProperty(exports, "multilineString", { enumerable: true, get: function () { return strings_1.multilineString; } });
 Object.defineProperty(exports, "singleLineString", { enumerable: true, get: function () { return strings_1.singleLineString; } });
 var table_1 = require("./lib/table");
-Object.defineProperty(exports, "table", { enumerable: true, get: function () { return table_1.default; } });
+Object.defineProperty(exports, "table", { enumerable: true, get: function () { return __importDefault(table_1).default; } });
 Object.defineProperty(exports, "printArray", { enumerable: true, get: function () { return table_1.printArray; } });
 Object.defineProperty(exports, "printObjectArray", { enumerable: true, get: function () { return table_1.printObjectArray; } });
 var progress_1 = require("./lib/progress");
-Object.defineProperty(exports, "progress", { enumerable: true, get: function () { return progress_1.default; } });
+Object.defineProperty(exports, "progress", { enumerable: true, get: function () { return __importDefault(progress_1).default; } });
 var inquirer_1 = require("./lib/inquirer");
-Object.defineProperty(exports, "inquirer", { enumerable: true, get: function () { return inquirer_1.default; } });
+Object.defineProperty(exports, "inquirer", { enumerable: true, get: function () { return __importDefault(inquirer_1).default; } });
 Object.defineProperty(exports, "confirm", { enumerable: true, get: function () { return inquirer_1.confirm; } });
@@ -54,3 +58,3 @@ Object.defineProperty(exports, "prompt", { enumerable: true, get: function () { return inquirer_1.prompt; } });
 var columnify_1 = require("./lib/columnify");
-Object.defineProperty(exports, "columnify", { enumerable: true, get: function () { return columnify_1.default; } });
+Object.defineProperty(exports, "columnify", { enumerable: true, get: function () { return __importDefault(columnify_1).default; } });
 //# sourceMappingURL=index.js.map

dist/lib/boxen.d.ts

 import boxen from 'boxen';
 import { LogLevels } from './logger';
 export default boxen;
+/**
+ * Prints the message inside a box
+ *
+ * @param level   the log level to display the message as
+ * @param msg     the message
+ */
 export declare const print: (level: LogLevels, msg: string) => void;
+/**
+ * Displays the message as a warning box
+ *
+ * @param msg         the message to display
+ * @param showSymbol  whether wrap the message in a warning symbol
+ */
 export declare const warning: (msg: string, showSymbol?: boolean) => void;
+/**
+ * Displays the message as an info box
+ *
+ * @param msg         the message to display
+ * @param showSymbol  whether wrap the message in an info symbol
+ */
 export declare const info: (msg: string, showSymbol?: boolean) => void;
+/**
+ * Displays the message as am error box
+ *
+ * @param msg         the message to display
+ * @param showSymbol  whether wrap the message in an error symbol
+ */
 export declare const error: (msg: string, showSymbol?: boolean) => void;
+/**
+ * Displays the message as a success box
+ *
+ * @param msg         the message to display
+ * @param showSymbol  whether wrap the message in a success symbol
+ */
 export declare const success: (msg: string, showSymbol?: boolean) => void;

dist/lib/boxen.js

@@ -11,3 +11,9 @@ "use strict";
 exports.default = boxen_1.default;
-exports.print = function (level, msg) {
+/**
+ * Prints the message inside a box
+ *
+ * @param level   the log level to display the message as
+ * @param msg     the message
+ */
+var print = function (level, msg) {
     var boxed = boxen_1.default(msg, {
@@ -19,3 +25,10 @@ padding: 1,
 };
-exports.warning = function (msg, showSymbol) {
+exports.print = print;
+/**
+ * Displays the message as a warning box
+ *
+ * @param msg         the message to display
+ * @param showSymbol  whether wrap the message in a warning symbol
+ */
+var warning = function (msg, showSymbol) {
     if (showSymbol === void 0) { showSymbol = true; }
@@ -28,3 +41,10 @@ var sym = log_symbols_1.default.warning;
 };
-exports.info = function (msg, showSymbol) {
+exports.warning = warning;
+/**
+ * Displays the message as an info box
+ *
+ * @param msg         the message to display
+ * @param showSymbol  whether wrap the message in an info symbol
+ */
+var info = function (msg, showSymbol) {
     if (showSymbol === void 0) { showSymbol = true; }
@@ -37,3 +57,10 @@ var sym = log_symbols_1.default.info;
 };
-exports.error = function (msg, showSymbol) {
+exports.info = info;
+/**
+ * Displays the message as am error box
+ *
+ * @param msg         the message to display
+ * @param showSymbol  whether wrap the message in an error symbol
+ */
+var error = function (msg, showSymbol) {
     if (showSymbol === void 0) { showSymbol = true; }
@@ -46,3 +73,10 @@ var sym = log_symbols_1.default.error;
 };
-exports.success = function (msg, showSymbol) {
+exports.error = error;
+/**
+ * Displays the message as a success box
+ *
+ * @param msg         the message to display
+ * @param showSymbol  whether wrap the message in a success symbol
+ */
+var success = function (msg, showSymbol) {
     if (showSymbol === void 0) { showSymbol = true; }
@@ -55,2 +89,3 @@ var sym = log_symbols_1.default.success;
 };
+exports.success = success;
 //# sourceMappingURL=boxen.js.map

dist/lib/inquirer.d.ts

@@ -12,6 +12,29 @@ import inquirer from 'inquirer';
 }
-export declare const _validateConfirmation: (defaultAnswer?: "Y" | "N" | undefined) => (input: string) => true | "Please answer with either \"y\" or \"n\"";
+/**
+ * Confirmation validator
+ *
+ * @param defaultAnswer
+ */
+export declare const _validateConfirmation: (defaultAnswer?: YNAnswer | undefined) => (input: string) => true | "Please answer with either \"y\" or \"n\"";
+/**
+ * Prompts the user to answer the question. Upon validation, returns the answer.
+ *
+ * @param question  the question to prompt the user with
+ */
 export declare const prompt: (question: Question) => Promise<Question['name']>;
-export declare const confirm: (question: string, defaultAnswer?: "Y" | "N" | undefined) => Promise<boolean>;
+/**
+ * Provides a confirmation prompt. The response is a Promise<boolean> with `true` resolving to
+ * successful confirmation, and `false` being the rejected confirmation
+ *
+ * @param question      the question to ask
+ * @param defaultAnswer the default answer, can be Y or N
+ */
+export declare const confirm: (question: string, defaultAnswer?: YNAnswer | undefined) => Promise<boolean>;
+/**
+ * Prompts the user to select from one of the choices.
+ *
+ * @param question  the question to prompt the user with
+ * @param choices   the list of options
+ */
 export declare const choose: (question: Question, choices: string[]) => Promise<Question['name']>;
 export default inquirer;

dist/lib/inquirer.js

@@ -47,3 +47,8 @@ "use strict";
 exports.acceptableAnswers = exports.positiveAnswers.concat(exports.negativeAnswers);
-exports._validateConfirmation = function (defaultAnswer) { return function (input) {
+/**
+ * Confirmation validator
+ *
+ * @param defaultAnswer
+ */
+var _validateConfirmation = function (defaultAnswer) { return function (input) {
     if (!input && defaultAnswer) {
@@ -57,3 +62,9 @@ input = defaultAnswer;
 }; };
-exports.prompt = function (question) { return __awaiter(void 0, void 0, void 0, function () {
+exports._validateConfirmation = _validateConfirmation;
+/**
+ * Prompts the user to answer the question. Upon validation, returns the answer.
+ *
+ * @param question  the question to prompt the user with
+ */
+var prompt = function (question) { return __awaiter(void 0, void 0, void 0, function () {
     var result, nameKey;
@@ -64,11 +75,19 @@ return __generator(this, function (_a) {
                 question.type = question.type || 'input';
-                return [4, inquirer_1.default.prompt([question])];
+                return [4 /*yield*/, inquirer_1.default.prompt([question])];
             case 1:
                 result = _a.sent();
                 nameKey = Object.keys(question).find(function (k) { return k === 'name'; });
-                return [2, result[question[nameKey]]];
+                return [2 /*return*/, result[question[nameKey]]];
         }
     });
 }); };
-exports.confirm = function (question, defaultAnswer) { return __awaiter(void 0, void 0, void 0, function () {
+exports.prompt = prompt;
+/**
+ * Provides a confirmation prompt. The response is a Promise<boolean> with `true` resolving to
+ * successful confirmation, and `false` being the rejected confirmation
+ *
+ * @param question      the question to ask
+ * @param defaultAnswer the default answer, can be Y or N
+ */
+var confirm = function (question, defaultAnswer) { return __awaiter(void 0, void 0, void 0, function () {
     var suffix, q, answer;
@@ -90,3 +109,3 @@ return __generator(this, function (_a) {
                 };
-                return [4, exports.prompt(q)];
+                return [4 /*yield*/, exports.prompt(q)];
             case 1:
@@ -98,15 +117,23 @@ answer = _a.sent();
                 if (exports.positiveAnswers.includes(answer.toLowerCase())) {
-                    return [2, Promise.resolve(true)];
+                    return [2 /*return*/, Promise.resolve(true)];
                 }
-                return [2, Promise.resolve(false)];
+                return [2 /*return*/, Promise.resolve(false)];
         }
     });
 }); };
-exports.choose = function (question, choices) { return __awaiter(void 0, void 0, void 0, function () {
+exports.confirm = confirm;
+/**
+ * Prompts the user to select from one of the choices.
+ *
+ * @param question  the question to prompt the user with
+ * @param choices   the list of options
+ */
+var choose = function (question, choices) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         question.type = 'list';
-        return [2, exports.prompt(Object.assign(question, { choices: choices }))];
+        return [2 /*return*/, exports.prompt(Object.assign(question, { choices: choices }))];
     });
 }); };
+exports.choose = choose;
 exports.default = inquirer_1.default;
 //# sourceMappingURL=inquirer.js.map

dist/lib/logger.d.ts

@@ -26,2 +26,5 @@ import chalk from 'chalk';
 };
+/**
+ * The Logger class
+ */
 export declare class Logger {
@@ -31,19 +34,83 @@ private static formatter;
     constructor(options?: LoggerOptions);
+    /**
+     * debug level log
+     * @param args
+     */
     debug: (...args: any[]) => void;
+    /**
+     * trace level trace
+     * @param args
+     */
     trace: (...args: any[]) => void;
+    /**
+     * info level log
+     * @param args
+     */
     info: (...args: any[]) => void;
+    /**
+     * success level log
+     * @param args
+     */
     success: (...args: any[]) => void;
+    /**
+     * error level log
+     * @param args
+     */
     error: (...args: any[]) => void;
+    /**
+     * warning level log
+     * @param args
+     */
     warning: (...args: any[]) => void;
+    /**
+     * Notice log is info level with a magenta color
+     * @param args
+     */
     notice: (...args: any[]) => void;
+    /**
+     * Simple wrapper for column printing
+     * @param lines
+     * @param options
+     */
     columns: (lines: string[][], options?: ColumnsOptions | undefined) => void;
+    /**
+     * Appends new line
+     * @param lines the number of lines to append
+     */
     newline: (lines?: number) => void;
+    /**
+     * A wrapper for showing bash command information such as `npm install foo`
+     * @param command the bash command
+     * @param args  the remaining arguments
+     */
     installInfo: (command: string, ...args: string[]) => void;
+    /**
+     * Clears the terminal either if forced is provided, or if persist_terminal env is not set
+     */
     clearTerminal: (forced?: boolean) => void;
+    /**
+     * Provides basic markdown support. Currently supported bold **bold** and italic *italic*
+     * @param msg
+     */
     markdown: (msg?: string | undefined) => string | undefined;
+    /**
+     * The internal logger method
+     * @param args
+     * @private
+     */
     private _log;
+    /**
+     * Checks whether the logger is set for debug mode
+     */
     private isDebug;
+    /**
+     * Checks whether the logger is set for trace mode
+     */
     private isTrace;
     private isQuiet;
 }
+/**
+ * The default logger will use environment variables to determine behavior.
+ * You can create an instance to overwrite default behavior.
+ */
 export declare const _logger: Logger;
@@ -69,3 +136,3 @@ declare const _default: {
         Level: chalk.Level;
-        Color: "red" | "yellow" | "green" | "cyan" | "magenta" | "black" | "blue" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright" | "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright";
+        Color: ("red" | "yellow" | "green" | "cyan" | "magenta" | "black" | "blue" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright") | ("bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright");
         ForegroundColor: "red" | "yellow" | "green" | "cyan" | "magenta" | "black" | "blue" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";
@@ -72,0 +139,0 @@ BackgroundColor: "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright";

dist/lib/logger.js

@@ -18,5 +18,6 @@ "use strict";
 };
-var __spread = (this && this.__spread) || function () {
-    for (var ar = [], i = 0; i < arguments.length; i++) ar = ar.concat(__read(arguments[i]));
-    return ar;
+var __spreadArray = (this && this.__spreadArray) || function (to, from) {
+    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
+        to[j] = from[i];
+    return to;
 };
@@ -28,2 +29,3 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 exports._logger = exports.Logger = exports.coloredStrings = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any, prefer-named-capture-group */
 var util_1 = require("util");
@@ -36,2 +38,3 @@ var chalk_1 = __importDefault(require("chalk"));
 var columnify_1 = __importDefault(require("./columnify"));
+// The default option for wrap-ansi
 var DefaultWrapOptions = { hard: true };
@@ -52,5 +55,12 @@ exports.coloredStrings = {
 };
-var Logger = (function () {
+/**
+ * The Logger class
+ */
+var Logger = /** @class */ (function () {
     function Logger(options) {
         var _this = this;
+        /**
+         * debug level log
+         * @param args
+         */
         this.debug = function () {
@@ -65,2 +75,6 @@ var args = [];
         };
+        /**
+         * trace level trace
+         * @param args
+         */
         this.trace = function () {
@@ -75,2 +89,6 @@ var args = [];
         };
+        /**
+         * info level log
+         * @param args
+         */
         this.info = function () {
@@ -83,2 +101,6 @@ var args = [];
         };
+        /**
+         * success level log
+         * @param args
+         */
         this.success = function () {
@@ -91,2 +113,6 @@ var args = [];
         };
+        /**
+         * error level log
+         * @param args
+         */
         this.error = function () {
@@ -99,2 +125,6 @@ var args = [];
         };
+        /**
+         * warning level log
+         * @param args
+         */
         this.warning = function () {
@@ -107,2 +137,6 @@ var args = [];
         };
+        /**
+         * Notice log is info level with a magenta color
+         * @param args
+         */
         this.notice = function () {
@@ -115,2 +149,7 @@ var args = [];
         };
+        /**
+         * Simple wrapper for column printing
+         * @param lines
+         * @param options
+         */
         this.columns = function (lines, options) {
@@ -123,2 +162,3 @@ var minWidths = Array(lines[0].length).fill(0);
             });
+            // Convert array to object
             var data = lines.map(function (line) {
@@ -130,2 +170,3 @@ return line.reduce(function (accum, entry, index) {
             });
+            // create the configuration
             var config = minWidths.reduce(function (accum, minWidth, index) {
@@ -147,2 +188,6 @@ if (index < minWidths.length - 1) {
         };
+        /**
+         * Appends new line
+         * @param lines the number of lines to append
+         */
         this.newline = function (lines) {
@@ -154,2 +199,7 @@ if (lines === void 0) { lines = 1; }
         };
+        /**
+         * A wrapper for showing bash command information such as `npm install foo`
+         * @param command the bash command
+         * @param args  the remaining arguments
+         */
         this.installInfo = function (command) {
@@ -160,4 +210,8 @@ var args = [];
             }
-            _this.info.apply(_this, __spread(['\t', chalk_1.default.cyan(command)], args));
+            _this.info.apply(_this, __spreadArray(['\t', chalk_1.default.cyan(command)], __read(args)));
         };
+        /**
+         * Clears the terminal either if forced is provided, or if persist_terminal env is not set
+         */
+        /* istanbul ignore next */
         this.clearTerminal = function (forced) {
@@ -169,2 +223,6 @@ if (forced === void 0) { forced = false; }
         };
+        /**
+         * Provides basic markdown support. Currently supported bold **bold** and italic *italic*
+         * @param msg
+         */
         this.markdown = function (msg) {
@@ -189,4 +247,10 @@ if (!msg || msg === '') {
         };
+        /**
+         * The internal logger method
+         * @param args
+         * @private
+         */
         this._log = function (args) {
             if (!_this.isQuiet() || args.level === 'error' || _this.isDebug()) {
+                // eslint-disable-next-line no-console
                 var log = console[args.level];
@@ -198,2 +262,5 @@ var color = args.color ? chalk_1.default[args.color] : function (msg) { return msg; };
         };
+        /**
+         * Checks whether the logger is set for debug mode
+         */
         this.isDebug = function () {
@@ -205,2 +272,5 @@ if ('isDebug' in _this.options) {
         };
+        /**
+         * Checks whether the logger is set for trace mode
+         */
         this.isTrace = function () {
@@ -270,2 +340,9 @@ if ('isTrace' in _this.options) {
 exports.Logger = Logger;
+/**
+ * Word wrapping using ANSI escape codes
+ *
+ * @param input     the string to wrap
+ * @param columns   number of columns
+ * @param options   options
+ */
 var wrap = function (input, columns, options) {
@@ -275,2 +352,6 @@ if (options === void 0) { options = DefaultWrapOptions; }
 };
+/**
+ * The default logger will use environment variables to determine behavior.
+ * You can create an instance to overwrite default behavior.
+ */
 exports._logger = new Logger();
@@ -277,0 +358,0 @@ var debug = exports._logger.debug, info = exports._logger.info, warning = exports._logger.warning, error = exports._logger.error, trace = exports._logger.trace, success = exports._logger.success, newline = exports._logger.newline, notice = exports._logger.notice, installInfo = exports._logger.installInfo, clearTerminal = exports._logger.clearTerminal, markdown = exports._logger.markdown, columns = exports._logger.columns;

dist/lib/progress.d.ts

@@ -7,4 +7,16 @@ export declare type Callback<R> = () => Promise<R>;
 }
+/**
+ * Added for testing purposes
+ * @param title
+ * @param disabled
+ */
 export declare const _getSpinner: (text: string, disabled: boolean) => Progress;
+/**
+ * An {@link ora} progress wrapper
+ *
+ * @param title   the title to show
+ * @param action  the callback to run
+ * @param disabled force enable the progress
+ */
 export declare const progress: <R>(title: string, action: Callback<R>, disabled?: boolean) => Promise<R>;
 export default progress;

dist/lib/progress.js

@@ -45,3 +45,5 @@ "use strict";
 var logger_1 = __importDefault(require("./logger"));
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 var ora = null;
+/* istanbul ignore next */
 var _getOra = function () {
@@ -51,13 +53,23 @@ if (ora) {
     }
+    // eslint-disable-next-line global-require, @typescript-eslint/no-require-imports
     ora = require('ora');
     return ora;
 };
-exports._getSpinner = function (text, disabled) {
+/**
+ * Added for testing purposes
+ * @param title
+ * @param disabled
+ */
+/* istanbul ignore next */
+var _getSpinner = function (text, disabled) {
     if (disabled) {
         return {
             start: function () {
+                // no-op
             },
             succeed: function () {
+                // no-op
             },
             fail: function () {
+                // no-op
             },
@@ -72,3 +84,11 @@ };
 };
-exports.progress = function (title, action, disabled) {
+exports._getSpinner = _getSpinner;
+/**
+ * An {@link ora} progress wrapper
+ *
+ * @param title   the title to show
+ * @param action  the callback to run
+ * @param disabled force enable the progress
+ */
+var progress = function (title, action, disabled) {
     if (disabled === void 0) { disabled = flex_plugins_utils_env_1.default.isQuiet(); }
@@ -85,7 +105,7 @@ return __awaiter(void 0, void 0, void 0, function () {
                     spinner.start();
-                    return [4, action()];
+                    return [4 /*yield*/, action()];
                 case 2:
                     response = _a.sent();
                     spinner.succeed();
-                    return [2, response];
+                    return [2 /*return*/, response];
                 case 3:
@@ -95,3 +115,3 @@ e_1 = _a.sent();
                     throw e_1;
-                case 4: return [2];
+                case 4: return [2 /*return*/];
             }
@@ -101,3 +121,4 @@ });
 };
+exports.progress = progress;
 exports.default = exports.progress;
 //# sourceMappingURL=progress.js.map

dist/lib/strings.d.ts

@@ -0,2 +1,11 @@
+/**
+ * Converts an array of arguments into a multiline string
+ *
+ * @param args  the lines to print
+ */
 export declare const multilineString: (...args: string[]) => string;
+/**
+ * Converts an array of string into a single lin
+ * @param args  the lines to print
+ */
 export declare const singleLineString: (...args: string[]) => string;
@@ -3,0 +12,0 @@ declare const _default: {

dist/lib/strings.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.singleLineString = exports.multilineString = void 0;
-exports.multilineString = function () {
+/**
+ * Converts an array of arguments into a multiline string
+ *
+ * @param args  the lines to print
+ */
+var multilineString = function () {
     var args = [];
@@ -11,3 +16,8 @@ for (var _i = 0; _i < arguments.length; _i++) {
 };
-exports.singleLineString = function () {
+exports.multilineString = multilineString;
+/**
+ * Converts an array of string into a single lin
+ * @param args  the lines to print
+ */
+var singleLineString = function () {
     var args = [];
@@ -19,2 +29,3 @@ for (var _i = 0; _i < arguments.length; _i++) {
 };
+exports.singleLineString = singleLineString;
 exports.default = {
@@ -21,0 +32,0 @@ multilineString: exports.multilineString,

dist/lib/table.d.ts

@@ -0,3 +1,19 @@
+/**
+ * Checks that the matrix's rows all have the same number of entries
+ *
+ * @param matrix
+ */
 export declare const isRegularMatrix: (matrix: string[][]) => boolean;
+/**
+ * Prints the data in a table format with the provided headers
+ *
+ * @param header  the header of the table
+ * @param data    the data entry to print
+ */
 export declare const printArray: (header: string[], data: string[][]) => void;
+/**
+ * Prints the data in a table format with the provided headers.
+ *
+ * @param data    the data entry to print
+ */
 export declare const printObjectArray: (data: object[]) => void;
@@ -4,0 +20,0 @@ declare const _default: {

dist/lib/table.js

@@ -28,6 +28,18 @@ "use strict";
 };
-exports.isRegularMatrix = function (matrix) {
+/**
+ * Checks that the matrix's rows all have the same number of entries
+ *
+ * @param matrix
+ */
+var isRegularMatrix = function (matrix) {
     return matrix && matrix.length > 0 && matrix[0].constructor === Array && matrix.every(function (r) { return r.length === matrix[0].length; });
 };
-exports.printArray = function (header, data) {
+exports.isRegularMatrix = isRegularMatrix;
+/**
+ * Prints the data in a table format with the provided headers
+ *
+ * @param header  the header of the table
+ * @param data    the data entry to print
+ */
+var printArray = function (header, data) {
     if (!exports.isRegularMatrix(data)) {
@@ -44,3 +56,10 @@ logger_1.default.warning('Table rows are not all the same length; this may produce an irregular tabular view.');
 };
-exports.printObjectArray = function (data) {
+exports.printArray = printArray;
+/**
+ * Prints the data in a table format with the provided headers.
+ *
+ * @param data    the data entry to print
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+var printObjectArray = function (data) {
     if (data.length !== 0) {
@@ -52,2 +71,3 @@ var header = Object.keys(data[0]);
 };
+exports.printObjectArray = printObjectArray;
 exports.default = {
@@ -54,0 +74,0 @@ isRegularMatrix: exports.isRegularMatrix,

package.json

 {
   "name": "flex-plugins-utils-logger",
-  "version": "0.19.0",
+  "version": "4.5.1-dev.202103291654",
   "description": "Flex Plugins Logger",
@@ -10,9 +10,9 @@ "keywords": [
   ],
-  "homepage": "https://github.com/twilio/flex-plugins-utils-logger#readme",
+  "homepage": "https://github.com/twilio/flex-plugin-builder",
   "bugs": {
-    "url": "https://github.com/twilio/flex-plugins-utils-logger/issues"
+    "url": "https://github.com/twilio/flex-plugin-builder/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/twilio/flex-plugins-utils-logger.git"
+    "url": "git+https://github.com/twilio/flex-plugin-builder.git"
   },
@@ -35,3 +35,3 @@ "license": "MIT",
     "prebuild": "npm run clean",
-    "build": "tsc",
+    "build": "../../node_modules/.bin/tsc",
     "clean": "rm -rf dist",
@@ -41,4 +41,4 @@ "lint": "eslint --ext ts src/",
     "prepublish": "npm run build",
-    "test": "cd ../.. && jest packages/flex-plugins-utils-logger",
-    "test:watch": "cd ../.. && jest packages/flex-plugins-utils-logger --watch"
+    "test": "cd ../.. && jest packages/flex-dev-utils --color",
+    "test:watch": "cd ../.. && jest packages/flex-dev-utils --watch --color"
   },
@@ -50,3 +50,3 @@ "dependencies": {
     "columnify": "^1.5.4",
-    "flex-plugins-utils-env": "^0.19.0",
+    "flex-plugins-utils-env": "^4.5.1-dev.202103291654",
     "inquirer": "7.3.3",
@@ -66,3 +66,3 @@ "log-symbols": "^3.0.0",
   },
-  "gitHead": "c30bba85fc858f3833333201ea50a74a4b584702"
+  "gitHead": "43ac792b54fcf24aba4a5c4dddfb47760ee5a5ce"
 }

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

66144

increased by19.19%

Lines of code

1171

increased by43.86%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

1

decreased by-50%

Dependency changes

• + Addedflex-plugins-utils-env@4.5.1-nightly.20210409(transitive)

• - Removedflex-plugins-utils-env@0.19.0(transitive)

• Updatedflex-plugins-utils-env@^4.5.1-dev.202103291654