From 96f6388ce17cdc1a8258e50ef95393a16f7d87fa Mon Sep 17 00:00:00 2001 From: Mark Griffiths Date: Fri, 15 Feb 2019 11:23:49 +0000 Subject: [PATCH 1/2] Move to ES6 Class --- index.js | 279 +++++++++++++-------------- index.mjs | 279 +++++++++++++-------------- src/index.js | 377 +------------------------------------ src/lib/verbosity.class.js | 2 +- test/logging.js | 18 +- test/module.js | 14 +- 6 files changed, 311 insertions(+), 658 deletions(-) diff --git a/index.js b/index.js index b17d31e..43091b2 100644 --- a/index.js +++ b/index.js @@ -5,7 +5,6 @@ Object.defineProperty(exports, '__esModule', { value: true }); function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } var util = _interopDefault(require('util')); -var console = require('console'); var termNG = _interopDefault(require('term-ng')); var chalk = _interopDefault(require('chalk')); var sparkles = _interopDefault(require('sparkles')); @@ -16,46 +15,48 @@ const { format, inspect } = util; -const metadata = meta(__dirname); - -const consoleFactory = function (options = {}) { - const { - outStream, - errorStream, - verbosity, - timestamp, - namespace, - prefix - } = options; - - const sOut = (ws => { - if (!ws.writable) { - throw new Error('Provided output stream must be writable'); - } +const { + Console +} = console; +class Verbosity extends Console { + constructor(options = {}) { + const { + outStream, + errorStream, + verbosity, + timestamp, + namespace, + prefix + } = options; + + const sOut = (ws => { + if (!ws.writable) { + throw new Error('Provided output stream must be writable'); + } - return ws; - })(outStream ? outStream : process.stdout); + return ws; + })(outStream ? outStream : process.stdout); - const sErr = (ws => { - if (!ws.writable) { - throw new Error('Provided error stream must be writable'); - } + const sErr = (ws => { + if (!ws.writable) { + throw new Error('Provided error stream must be writable'); + } - return ws; - })(errorStream ? errorStream : sOut); + return ws; + })(errorStream ? errorStream : sOut); - const willEmit = Boolean(namespace); + super(sOut, sErr); + this.willEmit = Boolean(namespace); - const timeFormatter = (ts => ts ? () => `[${chalk.dim(time.bespokeTimeFormat(ts))}] ` : () => '')(timestamp); + this.timeFormatter = (ts => ts ? () => `[${chalk.dim(time.bespokeTimeFormat(ts))}] ` : () => '')(timestamp); - const prefixFormatter = (pfix => pfix ? () => `[${pfix}] ` : () => '')(prefix); + this.prefixFormatter = (pfix => pfix ? () => `[${pfix}] ` : () => '')(prefix); - return Object.assign(new console.Console(sOut, sErr), { - _stdout: sOut, - _stderr: sErr, - threshold: verbosity ? verbosity : 3, - emitter: willEmit && sparkles(namespace), - matrix: { + this._stdout = sOut; + this._stderr = sErr; + this.threshold = verbosity ? verbosity : 3; + this.emitter = this.willEmit && sparkles(namespace); + this.matrix = { debug: { level: 5, stream: sOut, @@ -96,125 +97,125 @@ const consoleFactory = function (options = {}) { stream: sErr, format: (pfix, msg) => `${pfix}${chalk.bold.red(`EMERGENCY: ${msg}`)}` } - }, + }; + } - verbosity(level) { - level = typeof level === 'string' ? this.matrix[level] : level; + verbosity(level) { + level = typeof level === 'string' ? this.matrix[level] : level; - if (level < 6) { - this.threshold = level; - } + if (level < 6) { + this.threshold = level; + } - return this.threshold; - }, + return this.threshold; + } - canWrite(level) { - level = typeof level === 'string' ? this.matrix[level] : level; - return this.threshold >= level; - }, + canWrite(level) { + level = typeof level === 'string' ? this.matrix[level] : level; + return this.threshold >= level; + } - route(level, msg, ...a) { - msg = a.length > 0 ? format(msg, ...a) : msg; + route(level, msg, ...a) { + msg = a.length > 0 ? format(msg, ...a) : msg; - if (willEmit) { - this.emitter.emit(level, msg); - } + if (this.willEmit) { + this.emitter.emit(level, msg); + } - if (this.threshold >= this.matrix[level].level) { - const pfix = `${timeFormatter()}${prefixFormatter()}`; - this.matrix[level].stream.write(`${this.matrix[level].format(pfix, msg)}\n`); - } - }, - - debug(msg, ...args) { - this.route('debug', msg, ...args); - }, - - info(msg, ...args) { - this.route('info', msg, ...args); - }, - - log(msg, ...args) { - this.route('log', msg, ...args); - }, - - warn(msg, ...args) { - this.route('warn', msg, ...args); - }, - - error(msg, ...args) { - this.route('error', msg, ...args); - }, - - critical(msg, ...args) { - this.route('critical', msg, ...args); - }, - - panic(msg, ...args) { - this.route('panic', msg, ...args); - }, - - emergency(msg, ...args) { - this.route('emergency', msg, ...args); - }, - - dir(obj, options = {}) { - const { - depth = 0, - colors = termNG.color.basic - } = options; - options.depth = depth; - options.colors = colors; - sOut.write(format(inspect(obj, options))); - }, - - pretty(obj, depth = 0, color = true) { - sOut.write(format('Content: %s\n', inspect(obj, { - depth, - colors: color && termNG.color.basic - }).slice(0, -1).replace(/^{/, 'Object\n ').replace(/^\[/, 'Array\n ').replace(/^(\w+) {/, '$1').replace(/(\w+):/g, '$1 ▸').replace(/,\n/g, '\n'))); - }, - - yargs(obj, color = true) { - const parsed = {}; - Object.keys(obj).forEach(key_ => { - const val = obj[key_]; - - switch (key_) { - case '_': - if (val.length > 0) { - parsed.arguments = val.join(' '); - } - - break; - - case '$0': - parsed.self = val; - break; - - default: - if (key_.length > 1) { - parsed[key_] = val; - } - - } - }); - sOut.write(format('Options (yargs):\n %s\n', inspect(parsed, { - colors: color && termNG.color.basic - }).slice(2, -1).replace(/(\w+):/g, '$1 ▸').replace(/,\n/g, '\n'))); + if (this.threshold >= this.matrix[level].level) { + const pfix = `${this.timeFormatter()}${this.prefixFormatter()}`; + this.matrix[level].stream.write(`${this.matrix[level].format(pfix, msg)}\n`); } + } + + debug(msg, ...args) { + this.route('debug', msg, ...args); + } + + info(msg, ...args) { + this.route('info', msg, ...args); + } + + log(msg, ...args) { + this.route('log', msg, ...args); + } + + warn(msg, ...args) { + this.route('warn', msg, ...args); + } + + error(msg, ...args) { + this.route('error', msg, ...args); + } + + critical(msg, ...args) { + this.route('critical', msg, ...args); + } + + panic(msg, ...args) { + this.route('panic', msg, ...args); + } + + emergency(msg, ...args) { + this.route('emergency', msg, ...args); + } + + dir(obj, options = {}) { + const { + depth = 0, + colors = termNG.color.basic + } = options; + options.depth = depth; + options.colors = colors; + + this._stdout.write(format(inspect(obj, options))); + } + + pretty(obj, depth = 0, color = true) { + this._stdout.write(format('Content: %s\n', inspect(obj, { + depth, + colors: color && termNG.color.basic + }).slice(0, -1).replace(/^{/, 'Object\n ').replace(/^\[/, 'Array\n ').replace(/^(\w+) {/, '$1').replace(/(\w+):/g, '$1 ▸').replace(/,\n/g, '\n'))); + } + + yargs(obj, color = true) { + const parsed = {}; + Object.keys(obj).forEach(key_ => { + const val = obj[key_]; + + switch (key_) { + case '_': + if (val.length > 0) { + parsed.arguments = val.join(' '); + } + + break; + + case '$0': + parsed.self = val; + break; + + default: + if (key_.length > 1) { + parsed[key_] = val; + } - }); -}; + } + }); + + this._stdout.write(format('Options (yargs):\n %s\n', inspect(parsed, { + colors: color && termNG.color.basic + }).slice(2, -1).replace(/(\w+):/g, '$1 ▸').replace(/,\n/g, '\n'))); + } -function console$1(options) { - return consoleFactory(options); } + +const metadata = meta(__dirname); function createConsole(options) { - return consoleFactory(options); + return new Verbosity(options); } const getVersion = level => metadata.version(level); -exports.console = console$1; exports.createConsole = createConsole; exports.getVersion = getVersion; +exports.Verbosity = Verbosity; diff --git a/index.mjs b/index.mjs index e95b94f..7086d43 100644 --- a/index.mjs +++ b/index.mjs @@ -1,5 +1,4 @@ import util from 'util'; -import { Console } from 'console'; import termNG from 'term-ng'; import chalk from 'chalk'; import sparkles from 'sparkles'; @@ -10,46 +9,48 @@ const { format, inspect } = util; -const metadata = meta(__dirname); - -const consoleFactory = function (options = {}) { - const { - outStream, - errorStream, - verbosity, - timestamp, - namespace, - prefix - } = options; - - const sOut = (ws => { - if (!ws.writable) { - throw new Error('Provided output stream must be writable'); - } +const { + Console +} = console; +class Verbosity extends Console { + constructor(options = {}) { + const { + outStream, + errorStream, + verbosity, + timestamp, + namespace, + prefix + } = options; + + const sOut = (ws => { + if (!ws.writable) { + throw new Error('Provided output stream must be writable'); + } - return ws; - })(outStream ? outStream : process.stdout); + return ws; + })(outStream ? outStream : process.stdout); - const sErr = (ws => { - if (!ws.writable) { - throw new Error('Provided error stream must be writable'); - } + const sErr = (ws => { + if (!ws.writable) { + throw new Error('Provided error stream must be writable'); + } - return ws; - })(errorStream ? errorStream : sOut); + return ws; + })(errorStream ? errorStream : sOut); - const willEmit = Boolean(namespace); + super(sOut, sErr); + this.willEmit = Boolean(namespace); - const timeFormatter = (ts => ts ? () => `[${chalk.dim(bespokeTimeFormat(ts))}] ` : () => '')(timestamp); + this.timeFormatter = (ts => ts ? () => `[${chalk.dim(bespokeTimeFormat(ts))}] ` : () => '')(timestamp); - const prefixFormatter = (pfix => pfix ? () => `[${pfix}] ` : () => '')(prefix); + this.prefixFormatter = (pfix => pfix ? () => `[${pfix}] ` : () => '')(prefix); - return Object.assign(new Console(sOut, sErr), { - _stdout: sOut, - _stderr: sErr, - threshold: verbosity ? verbosity : 3, - emitter: willEmit && sparkles(namespace), - matrix: { + this._stdout = sOut; + this._stderr = sErr; + this.threshold = verbosity ? verbosity : 3; + this.emitter = this.willEmit && sparkles(namespace); + this.matrix = { debug: { level: 5, stream: sOut, @@ -90,123 +91,123 @@ const consoleFactory = function (options = {}) { stream: sErr, format: (pfix, msg) => `${pfix}${chalk.bold.red(`EMERGENCY: ${msg}`)}` } - }, + }; + } - verbosity(level) { - level = typeof level === 'string' ? this.matrix[level] : level; + verbosity(level) { + level = typeof level === 'string' ? this.matrix[level] : level; - if (level < 6) { - this.threshold = level; - } + if (level < 6) { + this.threshold = level; + } - return this.threshold; - }, + return this.threshold; + } - canWrite(level) { - level = typeof level === 'string' ? this.matrix[level] : level; - return this.threshold >= level; - }, + canWrite(level) { + level = typeof level === 'string' ? this.matrix[level] : level; + return this.threshold >= level; + } - route(level, msg, ...a) { - msg = a.length > 0 ? format(msg, ...a) : msg; + route(level, msg, ...a) { + msg = a.length > 0 ? format(msg, ...a) : msg; - if (willEmit) { - this.emitter.emit(level, msg); - } + if (this.willEmit) { + this.emitter.emit(level, msg); + } - if (this.threshold >= this.matrix[level].level) { - const pfix = `${timeFormatter()}${prefixFormatter()}`; - this.matrix[level].stream.write(`${this.matrix[level].format(pfix, msg)}\n`); - } - }, - - debug(msg, ...args) { - this.route('debug', msg, ...args); - }, - - info(msg, ...args) { - this.route('info', msg, ...args); - }, - - log(msg, ...args) { - this.route('log', msg, ...args); - }, - - warn(msg, ...args) { - this.route('warn', msg, ...args); - }, - - error(msg, ...args) { - this.route('error', msg, ...args); - }, - - critical(msg, ...args) { - this.route('critical', msg, ...args); - }, - - panic(msg, ...args) { - this.route('panic', msg, ...args); - }, - - emergency(msg, ...args) { - this.route('emergency', msg, ...args); - }, - - dir(obj, options = {}) { - const { - depth = 0, - colors = termNG.color.basic - } = options; - options.depth = depth; - options.colors = colors; - sOut.write(format(inspect(obj, options))); - }, - - pretty(obj, depth = 0, color = true) { - sOut.write(format('Content: %s\n', inspect(obj, { - depth, - colors: color && termNG.color.basic - }).slice(0, -1).replace(/^{/, 'Object\n ').replace(/^\[/, 'Array\n ').replace(/^(\w+) {/, '$1').replace(/(\w+):/g, '$1 ▸').replace(/,\n/g, '\n'))); - }, - - yargs(obj, color = true) { - const parsed = {}; - Object.keys(obj).forEach(key_ => { - const val = obj[key_]; - - switch (key_) { - case '_': - if (val.length > 0) { - parsed.arguments = val.join(' '); - } - - break; - - case '$0': - parsed.self = val; - break; - - default: - if (key_.length > 1) { - parsed[key_] = val; - } - - } - }); - sOut.write(format('Options (yargs):\n %s\n', inspect(parsed, { - colors: color && termNG.color.basic - }).slice(2, -1).replace(/(\w+):/g, '$1 ▸').replace(/,\n/g, '\n'))); + if (this.threshold >= this.matrix[level].level) { + const pfix = `${this.timeFormatter()}${this.prefixFormatter()}`; + this.matrix[level].stream.write(`${this.matrix[level].format(pfix, msg)}\n`); } + } + + debug(msg, ...args) { + this.route('debug', msg, ...args); + } + + info(msg, ...args) { + this.route('info', msg, ...args); + } + + log(msg, ...args) { + this.route('log', msg, ...args); + } + + warn(msg, ...args) { + this.route('warn', msg, ...args); + } + + error(msg, ...args) { + this.route('error', msg, ...args); + } + + critical(msg, ...args) { + this.route('critical', msg, ...args); + } + + panic(msg, ...args) { + this.route('panic', msg, ...args); + } + + emergency(msg, ...args) { + this.route('emergency', msg, ...args); + } + + dir(obj, options = {}) { + const { + depth = 0, + colors = termNG.color.basic + } = options; + options.depth = depth; + options.colors = colors; + + this._stdout.write(format(inspect(obj, options))); + } + + pretty(obj, depth = 0, color = true) { + this._stdout.write(format('Content: %s\n', inspect(obj, { + depth, + colors: color && termNG.color.basic + }).slice(0, -1).replace(/^{/, 'Object\n ').replace(/^\[/, 'Array\n ').replace(/^(\w+) {/, '$1').replace(/(\w+):/g, '$1 ▸').replace(/,\n/g, '\n'))); + } + + yargs(obj, color = true) { + const parsed = {}; + Object.keys(obj).forEach(key_ => { + const val = obj[key_]; + + switch (key_) { + case '_': + if (val.length > 0) { + parsed.arguments = val.join(' '); + } + + break; + + case '$0': + parsed.self = val; + break; + + default: + if (key_.length > 1) { + parsed[key_] = val; + } - }); -}; + } + }); + + this._stdout.write(format('Options (yargs):\n %s\n', inspect(parsed, { + colors: color && termNG.color.basic + }).slice(2, -1).replace(/(\w+):/g, '$1 ▸').replace(/,\n/g, '\n'))); + } -function console(options) { - return consoleFactory(options); } + +const metadata = meta(__dirname); function createConsole(options) { - return consoleFactory(options); + return new Verbosity(options); } const getVersion = level => metadata.version(level); -export { console, createConsole, getVersion }; +export { createConsole, getVersion, Verbosity }; diff --git a/src/index.js b/src/index.js index 54aac2f..bd7f7e3 100644 --- a/src/index.js +++ b/src/index.js @@ -2,385 +2,18 @@ │ verbosity │ Verbosity Controlling Console Writer/Emitter ╰───────────┴────────────────────────────────────────────────────────────────── */ -import util from 'util' - -import {Console} from 'console' - -import termNG from 'term-ng' -import chalk from 'chalk' -import sparkles from 'sparkles' -import {bespokeTimeFormat} from '@thebespokepixel/time' import meta from '@thebespokepixel/meta' +import Verbosity from './lib/verbosity.class' -const {format, inspect} = util const metadata = meta(__dirname) /** - * Generate a verbosity console - * @param {Object} options - Configuration options. - * @param {stream.writable} options.outStream - Stream to write normal output - * @param {stream.writable} options.errorStream - Stream to write error output - * @param {Number} options.verbosity - The verboseness of output: - * 0: Mute - * 1: Errors - * 2: Notice - * 3: Log - * 4: Info - * 5: Debug - * @param {String} options.timestamp - Timestamp format. - * @param {String} options.namespace - Sparkles namespace to emit events to. - * @param {String} options.prefix - Logging message prefix. - * @return {VerbosityConsole} Verbosity's console object. - */ -const consoleFactory = function (options = {}) { - const { - outStream, errorStream, verbosity, timestamp, namespace, prefix - } = options - - const sOut = (ws => { - if (!ws.writable) { - throw new Error('Provided output stream must be writable') - } - return ws - })(outStream ? outStream : process.stdout) - - const sErr = (ws => { - if (!ws.writable) { - throw new Error('Provided error stream must be writable') - } - return ws - })(errorStream ? errorStream : sOut) - - const willEmit = Boolean(namespace) - - const timeFormatter = (ts => ts ? - () => `[${chalk.dim(bespokeTimeFormat(ts))}] ` : - () => '' - )(timestamp) - - const prefixFormatter = (pfix => pfix ? - () => `[${pfix}] ` : - () => '' - )(prefix) - - return Object.assign(new Console(sOut, sErr), { - _stdout: sOut, - _stderr: sErr, - threshold: verbosity ? verbosity : 3, - emitter: willEmit && sparkles(namespace), - /** - * Message routing and formatting matrix. - * @private - * @type {Object} - */ - matrix: { - debug: { - level: 5, - stream: sOut, - /** - * Format the debug message. - * @private - * @param {String} pfix Message prefix. - * @param {String} msg The message body. - * @return {Sring} The formatted mesage. - */ - format: (pfix, msg) => `${pfix}${chalk.dim(msg)}` - }, - info: { - level: 4, - stream: sOut, - /** - * Format the info message. - * @private - * @param {String} pfix Message prefix. - * @param {String} msg The message body. - * @return {Sring} The formatted mesage. - */ - format: (pfix, msg) => `${pfix}${msg}` - }, - log: { - level: 3, - stream: sOut, - /** - * Format the log message. - * @private - * @param {String} pfix Message prefix. - * @param {String} msg The message body. - * @return {Sring} The formatted mesage. - */ - format: (pfix, msg) => `${pfix}${msg}` - }, - warn: { - level: 2, - stream: sErr, - /** - * Format the warn message. - * @private - * @param {String} pfix Message prefix. - * @param {String} msg The message body. - * @return {Sring} The formatted mesage. - */ - format: (pfix, msg) => `${pfix}${chalk.yellow(msg)}` - }, - error: { - level: 1, - stream: sErr, - /** - * Format the error message. - * @private - * @param {String} pfix Message prefix. - * @param {String} msg The message body. - * @return {Sring} The formatted mesage. - */ - format: (pfix, msg) => `${pfix}${chalk.red(`ERROR: ${msg}`)}` - }, - critical: { - level: 0, - stream: sErr, - /** - * Format the critical message. - * @private - * @param {String} pfix Message prefix. - * @param {String} msg The message body. - * @return {Sring} The formatted mesage. - */ - format: (pfix, msg) => `${pfix}${chalk.bold.red(`CRITICAL: ${msg}`)}` - }, - panic: { - level: 0, - stream: sErr, - /** - * Format the panic message. - * @private - * @param {String} pfix Message prefix. - * @param {String} msg The message body. - * @return {Sring} The formatted mesage. - */ - format: (pfix, msg) => `${pfix}${chalk.bold.red(`PANIC: ${msg}`)}` - }, - emergency: { - level: 0, - stream: sErr, - /** - * Format the emergency message. - * @private - * @param {String} pfix Message prefix. - * @param {String} msg The message body. - * @return {Sring} The formatted mesage. - */ - format: (pfix, msg) => `${pfix}${chalk.bold.red(`EMERGENCY: ${msg}`)}` - } - }, - /** - * Set the current verbosity. - * @param {Number} level - The current level (0 to 5). - * @return {Number} The current verboseness (0 to 5). - */ - verbosity(level) { - level = (typeof level === 'string') ? this.matrix[level] : level - if (level < 6) { - this.threshold = level - } - return this.threshold - }, - /** - * Can the requested logging level be written at this time. - * @param {Number} level - The requested level (0 to 5). - * @return {Boolean} `true` if ok to write. - */ - canWrite(level) { - level = (typeof level === 'string') ? this.matrix[level] : level - return this.threshold >= level - }, - /** - * Route message and emit if required. - * @private - * @param {Number} level Source logging level - * @param {String} msg Message to log - * @param {...String} a Additional arguments to log - */ - route(level, msg, ...a) { - msg = (a.length > 0) ? format(msg, ...a) : msg - if (willEmit) { - this.emitter.emit(level, msg) - } - if (this.threshold >= this.matrix[level].level) { - const pfix = `${timeFormatter()}${prefixFormatter()}` - this.matrix[level].stream.write(`${this.matrix[level].format(pfix, msg)}\n`) - } - }, - /** - * Log a debug message. (Level 5) - * @param {String} msg The debug message to log. - * @param {...String} args Additional arguments to log. - */ - debug(msg, ...args) { - this.route('debug', msg, ...args) - }, - /** - * Log an info message. (Level 4) - * @param {String} msg The info message to log. - * @param {...String} args Additional arguments to log. - */ - info(msg, ...args) { - this.route('info', msg, ...args) - }, - /** - * Log a normal message. (Level 3) - * @param {String} msg The normal message to log. - * @param {...String} args Additional arguments to log. - */ - log(msg, ...args) { - this.route('log', msg, ...args) - }, - /** - * Log a warning message. (Level 2) - * @param {String} msg The warning message to log. - * @param {...String} args Additional arguments to log. - */ - warn(msg, ...args) { - this.route('warn', msg, ...args) - }, - /** - * Log an error message. (Level 1) - * @param {String} msg The error message to log. - * @param {...String} args Additional arguments to log. - */ - error(msg, ...args) { - this.route('error', msg, ...args) - }, - /** - * Log a critical error message, if something breaks. (Level 1) - * @param {String} msg The critical error message to log. - * @param {...String} args Additional arguments to log. - */ - critical(msg, ...args) { - this.route('critical', msg, ...args) - }, - /** - * Log a panic error message if something unexpected happens. (Level 1) - * @param {String} msg The panic message to log. - * @param {...String} args Additional arguments to log. - */ - panic(msg, ...args) { - this.route('panic', msg, ...args) - }, - /** - * Log a emergency message, for when something needs emergency attention. (Level 1) - * @param {String} msg The debug message to log. - * @param {...String} args Additional arguments to log. - */ - emergency(msg, ...args) { - this.route('emergency', msg, ...args) - }, - /** - * As console.dir, but defaults to colour (if appropriate) and zero depth. - * @param {Object} obj The Object to print. - * @param {Object} options As console.dir options object. - */ - dir(obj, options = {}) { - const {depth = 0, colors = termNG.color.basic} = options - options.depth = depth - options.colors = colors - sOut.write(format(inspect(obj, options))) - }, - /** - * Pretty prints object, similar to OS X's plutil -p. Defaults to zero depth. - * @param {Object} obj The Object to print. - * @param {Number} depth How many object levels to print. - * @param {Boolean} color Print output in color, if supported. - * @example - * console.pretty(console) - * - * // Outputs: - * Object: VerbosityMatrix - * critical ▸ [Function] - * error ▸ [Function ▸ bound ] - * warn ▸ [Function ▸ bound ] - * log ▸ [Function ▸ bound ] - * info ▸ [Function ▸ bound ] - * debug ▸ [Function] - * canWrite ▸ [Function] - * ... - */ - pretty(obj, depth = 0, color = true) { - sOut.write(format('Content: %s\n', inspect(obj, { - depth, - colors: color && termNG.color.basic - }) - .slice(0, -1) - .replace(/^{/, 'Object\n ') - .replace(/^\[/, 'Array\n ') - .replace(/^(\w+) {/, '$1') - .replace(/(\w+):/g, '$1 ▸') - .replace(/,\n/g, '\n') - )) - }, - /** - * Helper function for pretty printing a summary of the current 'yargs' options. - * - * Only prints 'long options', `._` as 'arguments' and `$0` as 'self'. - * @param {Object} obj The Yargs argv object to print. - * @param {Boolean} color Print output in color, if supported. - * @example - * console.yargs(yargs) - * - * // Outputs: - * Object (yargs): - * left ▸ 2 - * right ▸ 2 - * mode ▸ 'hard' - * encoding ▸ 'utf8' - * ... - * self ▸ '/usr/local/bin/truwrap' - */ - yargs(obj, color = true) { - const parsed = {} - Object.keys(obj).forEach(key_ => { - const val = obj[key_] - switch (key_) { - case '_': - if (val.length > 0) { - parsed.arguments = val.join(' ') - } - break - case '$0': - parsed.self = val - break - default: - if (key_.length > 1) { - parsed[key_] = val - } - } - }) - sOut.write(format('Options (yargs):\n %s\n', inspect(parsed, { - colors: color && termNG.color.basic - }) - .slice(2, -1) - .replace(/(\w+):/g, '$1 ▸') - .replace(/,\n/g, '\n'))) - } - }) -} - -/** - * Create a new VerbosityConsole object. - * @private - * @deprecated Use `createConsole` instead. + * Create a new Verbosity object. * @param {Object} options Options to pass to the factory. - * @return {VerbosityConsole} Verbosity's console object. - */ -export function console(options) { - return consoleFactory(options) -} - -/** - * Create a new VerbosityConsole object. - * @param {Object} options Options to pass to the factory. - * @return {VerbosityConsole} Verbosity's console object. + * @return {Verbosity} Verbosity's console object. */ export function createConsole(options) { - return consoleFactory(options) + return new Verbosity(options) } /** @@ -390,3 +23,5 @@ export function createConsole(options) { * @return {String} The version string. */ export const getVersion = level => metadata.version(level) + +export {Verbosity} diff --git a/src/lib/verbosity.class.js b/src/lib/verbosity.class.js index 2a7019f..741704e 100644 --- a/src/lib/verbosity.class.js +++ b/src/lib/verbosity.class.js @@ -25,7 +25,7 @@ const {Console} = console * @param {String} options.timestamp - Timestamp format. * @param {String} options.namespace - Sparkles namespace to emit events to. * @param {String} options.prefix - Logging message prefix. - * @return {VerbosityConsole} Verbosity's console object. + * @return {Verbosity} Verbosity's console object. */ export default class Verbosity extends Console { constructor(options = {}) { diff --git a/test/logging.js b/test/logging.js index 3e76c15..4ec8990 100644 --- a/test/logging.js +++ b/test/logging.js @@ -71,14 +71,14 @@ const levels = [{ critical: logbold('Damn you Chell, not again.', 'red', 'CRITICAL: ', true) }] -function runSuite(console_, stamp_ = '') { +function runSuite(title_, console_, stamp_ = '') { let targetLevel = 5 levels.forEach(suite => { console_.verbosity(targetLevel) Object.keys(suite).forEach(level => { console_[level](suite[level].src) const result = StreamProxy.read() - test(`@ ${targetLevel}, Level: ${level}: ${['-', stamp_ + suite[level].raw][0 | suite[level].willRead]}`, t => { + test(`${title_} @ ${targetLevel}, Level: ${level}: ${['-', stamp_ + suite[level].raw][0 | suite[level].willRead]}`, t => { if (suite[level].willRead) { t.deepEqual(`${stamp_}${suite[level].dest}`, result) } else { @@ -90,9 +90,15 @@ function runSuite(console_, stamp_ = '') { }) } -let testConsole = createConsole({outStream: StreamProxy}) -runSuite(testConsole) +runSuite( + 'Normal', + createConsole({outStream: StreamProxy}) +) -testConsole = createConsole({outStream: StreamProxy, timestamp: 'XX:XX:XX'}) -runSuite(testConsole, `[${chalk.dim('XX:XX:XX')}] `) + +runSuite( + 'Timestamp', + createConsole({outStream: StreamProxy, timestamp: 'XX:XX:XX'}), + `[${chalk.dim('XX:XX:XX')}] ` +) diff --git a/test/module.js b/test/module.js index 90c00fe..094951c 100644 --- a/test/module.js +++ b/test/module.js @@ -2,7 +2,7 @@ import stream from 'stream' import test from 'ava' -import {createConsole, getVersion} from '..' +import {createConsole, getVersion, Verbosity} from '..' import pkg from '../package' const StreamProxy = new stream.PassThrough() @@ -16,13 +16,23 @@ test(`Module long version is '${pkg.name} v${pkg.version}'.`, t => { t.is(`${pkg.name} v${pkg.version}`, getVersion(2)) }) -const testConsole = createConsole({outStream: StreamProxy}) +test('console is instance of Verbosity', t => { + const testConsole = createConsole({outStream: StreamProxy}) + t.true(testConsole instanceof Verbosity) +}) + +test('console is instance of console.Console', t => { + const testConsole = createConsole({outStream: StreamProxy}) + t.true(testConsole instanceof console.Console) +}) test('Default level is 3 (log)', t => { + const testConsole = createConsole({outStream: StreamProxy}) t.is(testConsole.verbosity(), 3) }) test('Set log level to 1 (error)', t => { + const testConsole = createConsole({outStream: StreamProxy}) testConsole.verbosity(1) t.is(testConsole.verbosity(), 1) }) From 49e144de2098e47c249e83d17199dd431959f15a Mon Sep 17 00:00:00 2001 From: Mark Griffiths Date: Fri, 15 Feb 2019 11:29:27 +0000 Subject: [PATCH 2/2] Update example --- src/docs/example.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/src/docs/example.md b/src/docs/example.md index 9573d25..4e2ae45 100644 --- a/src/docs/example.md +++ b/src/docs/example.md @@ -9,19 +9,23 @@ npm install --save verbosity Simply override the built in console object: ```javascript -const console = require('../../index.js').createConsole({ - outStream: process.stdout, - errorStream: process.stderr, - verbosity: 5 +import {createConsole} from 'verbosity' + +const console = createConsole({ + outStream: process.stdout, + errorStream: process.stderr, + verbosity: 5 }) ``` This will direct all console output to stderr, but silence 'info' and 'debug' messages. ```javascript -const console = require('../../index.js').createConsole({ - outStream: process.stderr, - verbosity: 3 +import {createConsole} from 'verbosity' + +const console = createConsole({ + outStream: process.stderr, + verbosity: 3 }) console.log('Picked brown jacket...') // Printed @@ -32,9 +36,11 @@ console.warn("That tie doesn't go with that jacket.") // Printed Or go mad with making up any number of custom console writers. ```javascript -const myUberConsole = require('../../index.js').createConsole({ - outStream: myFancyWriteableStream, - verbosity: 5 +import {createConsole} from 'verbosity' + +const myUberConsole = createConsole({ + outStream: myFancyWriteableStream, + verbosity: 5 }) myUberConsole.panic('Core Flux Capacitor Meltdown!')