@percy/logger 1.12.0 → 1.14.0

package/dist/logger.js

@@ -6,48 +6,52 @@ const LOG_LEVELS = {
   info: 1,
   warn: 2,
   error: 3
-}; // A PercyLogger instance retains logs in-memory for quick lookups while also writing log
-// messages to stdout and stderr depending on the log level and debug string.
+};
 
+// A PercyLogger instance retains logs in-memory for quick lookups while also writing log
+// messages to stdout and stderr depending on the log level and debug string.
 export class PercyLogger {
   // default log level
-  level = 'info'; // namespace regular expressions used to determine which debug logs to write
+  level = 'info';
 
+  // namespace regular expressions used to determine which debug logs to write
   namespaces = {
     include: [/^.*?$/],
     exclude: []
-  }; // in-memory store for logs and meta info
+  };
 
-  messages = new Set(); // track deprecations to limit noisy logging
+  // in-memory store for logs and meta info
+  messages = new Set();
 
-  deprecations = new Set(); // static vars can be overriden for testing
+  // track deprecations to limit noisy logging
+  deprecations = new Set();
 
+  // static vars can be overriden for testing
   static stdout = process.stdout;
-  static stderr = process.stderr; // Handles setting env var values and returns a singleton
+  static stderr = process.stderr;
 
+  // Handles setting env var values and returns a singleton
   constructor() {
     let {
       instance = this
     } = this.constructor;
-
     if (process.env.PERCY_DEBUG) {
       instance.debug(process.env.PERCY_DEBUG);
     } else if (process.env.PERCY_LOGLEVEL) {
       instance.loglevel(process.env.PERCY_LOGLEVEL);
     }
-
     this.constructor.instance = instance;
     return instance;
-  } // Change log level at any time or return the current log level
-
+  }
 
+  // Change log level at any time or return the current log level
   loglevel(level) {
     if (level) this.level = level;
     return this.level;
-  } // Change namespaces by generating an array of namespace regular expressions from a
-  // comma separated debug string
-
+  }
 
+  // Change namespaces by generating an array of namespace regular expressions from a
+  // comma separated debug string
   debug(namespaces) {
     if (this.namespaces.string === namespaces) return;
     this.namespaces.string = namespaces;
@@ -56,22 +60,20 @@ export class PercyLogger {
     this.loglevel('debug');
     this.namespaces = namespaces.reduce((namespaces, ns) => {
       ns = ns.replace(/:?\*/g, m => m[0] === ':' ? ':?.*?' : '.*?');
-
       if (ns[0] === '-') {
         namespaces.exclude.push(new RegExp('^' + ns.substr(1) + '$'));
       } else {
         namespaces.include.push(new RegExp('^' + ns + '$'));
       }
-
       return namespaces;
     }, {
       string: namespaces,
       include: [],
       exclude: []
     });
-  } // Creates a new log group and returns level specific functions for logging
-
+  }
 
+  // Creates a new log group and returns level specific functions for logging
   group(name) {
     return Object.keys(LOG_LEVELS).reduce((group, level) => Object.assign(group, {
       [level]: this.log.bind(this, name, level)
@@ -84,44 +86,43 @@ export class PercyLogger {
       stdout: this.constructor.stdout,
       stderr: this.constructor.stderr
     });
-  } // Query for a set of logs by filtering the in-memory store
-
+  }
 
+  // Query for a set of logs by filtering the in-memory store
   query(filter) {
     return Array.from(this.messages).filter(filter);
-  } // Formats messages before they are logged to stdio
-
+  }
 
+  // Formats messages before they are logged to stdio
   format(debug, level, message, elapsed) {
     let color = (n, m) => this.isTTY ? colors[n](m) : m;
-
     let begin,
-        end,
-        suffix = '';
+      end,
+      suffix = '';
     let label = 'percy';
-
     if (arguments.length === 1) {
       // format(message)
       [debug, message] = [null, debug];
     } else if (arguments.length === 2) {
       // format(debug, message)
       [level, message] = [null, level];
-    } // do not format leading or trailing newlines
-
+    }
 
-    [, begin, message, end] = message.match(LINE_PAD_REGEXP); // include debug information
+    // do not format leading or trailing newlines
+    [, begin, message, end] = message.match(LINE_PAD_REGEXP);
 
+    // include debug information
     if (this.level === 'debug') {
-      if (debug) label += `:${debug}`; // include elapsed time since last log
+      if (debug) label += `:${debug}`;
 
+      // include elapsed time since last log
       if (elapsed != null) {
         suffix = ' ' + color('grey', `(${elapsed}ms)`);
       }
-    } // add colors
-
+    }
 
+    // add colors
     label = color('magenta', label);
-
     if (level === 'error') {
       // red errors
       message = color('red', message);
@@ -132,54 +133,52 @@ export class PercyLogger {
       // blue info and debug URLs
       message = message.replace(URL_REGEXP, color('blue', '$&'));
     }
-
     return `${begin}[${label}] ${message}${suffix}${end}`;
-  } // True if stdout is a TTY interface
-
+  }
 
+  // True if stdout is a TTY interface
   get isTTY() {
     return !!this.constructor.stdout.isTTY;
-  } // Replaces the current line with a log message
-
+  }
 
+  // Replaces the current line with a log message
   progress(debug, message, persist) {
     if (!this.shouldLog(debug, 'info')) return;
     let {
       stdout
     } = this.constructor;
-
     if (this.isTTY || !this._progress) {
       message && (message = this.format(debug, message));
       if (this.isTTY) stdout.cursorTo(0);else message && (message = message + '\n');
       if (message) stdout.write(message);
       if (this.isTTY) stdout.clearLine(1);
     }
-
     this._progress = !!message && {
       message,
       persist
     };
-  } // Returns true or false if the level and debug group can write messages to stdio
-
+  }
 
+  // Returns true or false if the level and debug group can write messages to stdio
   shouldLog(debug, level) {
     return LOG_LEVELS[level] != null && LOG_LEVELS[level] >= LOG_LEVELS[this.level] && !this.namespaces.exclude.some(ns => ns.test(debug)) && this.namespaces.include.some(ns => ns.test(debug));
-  } // Ensures that deprecation messages are not logged more than once
-
+  }
 
+  // Ensures that deprecation messages are not logged more than once
   deprecated(debug, message, meta) {
     if (this.deprecations.has(message)) return;
     this.deprecations.add(message);
     this.log(debug, 'warn', `Warning: ${message}`, meta);
-  } // Generic log method accepts a debug group, log level, log message, and optional meta
-  // information to store with the message and other info
-
+  }
 
+  // Generic log method accepts a debug group, log level, log message, and optional meta
+  // information to store with the message and other info
   log(debug, level, message, meta = {}) {
     // message might be an error-like object
     let err = typeof message !== 'string' && (level === 'debug' || level === 'error');
-    err && (err = message.message ? Error.prototype.toString.call(message) : message.toString()); // save log entries
+    err && (err = message.message ? Error.prototype.toString.call(message) : message.toString());
 
+    // save log entries
     let timestamp = Date.now();
     message = err ? message.stack || err : message.toString();
     let entry = {
@@ -190,19 +189,21 @@ export class PercyLogger {
       timestamp,
       error: !!err
     };
-    this.messages.add(entry); // maybe write the message to stdio
+    this.messages.add(entry);
 
+    // maybe write the message to stdio
     if (this.shouldLog(debug, level)) {
       // unless the loglevel is debug, write shorter error messages
       if (err && this.level !== 'debug') message = err;
-      this.write({ ...entry,
+      this.write({
+        ...entry,
         message
       });
       this.lastlog = timestamp;
     }
-  } // Writes a log entry to stdio based on the loglevel
-
+  }
 
+  // Writes a log entry to stdio based on the loglevel
   write({
     debug,
     level,
@@ -211,23 +212,21 @@ export class PercyLogger {
     error
   }) {
     var _this$_progress;
-
     let elapsed = timestamp - (this.lastlog || timestamp);
     let msg = this.format(debug, error ? 'error' : level, message, elapsed);
     let progress = this.isTTY && this._progress;
     let {
       stdout,
       stderr
-    } = this.constructor; // clear any logged progress
+    } = this.constructor;
 
+    // clear any logged progress
     if (progress) {
       stdout.cursorTo(0);
       stdout.clearLine(0);
     }
-
     (level === 'info' ? stdout : stderr).write(msg + '\n');
     if (!((_this$_progress = this._progress) !== null && _this$_progress !== void 0 && _this$_progress.persist)) delete this._progress;else if (progress) stdout.write(progress.message);
   }
-
 }
 export default PercyLogger;

package/dist/utils.js

@@ -1,10 +1,12 @@
 const {
   assign,
   entries
-} = Object; // matches ansi escape sequences
+} = Object;
 
-export const ANSI_REG = new RegExp('[\\u001B\\u009B][[\\]()#;?]*((?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)' + '|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))', 'g'); // color names by ansi escape code
+// matches ansi escape sequences
+export const ANSI_REG = new RegExp('[\\u001B\\u009B][[\\]()#;?]*((?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)' + '|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))', 'g');
 
+// color names by ansi escape code
 export const ANSI_COLORS = {
   '91m': 'red',
   '32m': 'green',
@@ -12,15 +14,15 @@ export const ANSI_COLORS = {
   '34m': 'blue',
   '95m': 'magenta',
   '90m': 'grey'
-}; // colorize each line of a string using an ansi escape sequence
+};
 
+// colorize each line of a string using an ansi escape sequence
 const LINE_REG = /^.*$/gm;
-
 function colorize(code, str) {
   return str.replace(LINE_REG, line => `\u001b[${code}${line}\u001b[39m`);
-} // map ansi colors to bound colorize functions
-
+}
 
+// map ansi colors to bound colorize functions
 export const colors = entries(ANSI_COLORS).reduce((colors, [code, name]) => {
   return assign(colors, {
     [name]: colorize.bind(null, code)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/logger",
-  "version": "1.12.0",
+  "version": "1.14.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -31,5 +31,5 @@
     "test": "node ../../scripts/test",
     "test:coverage": "yarn test --coverage"
   },
-  "gitHead": "4303b74df91f60e36065141289d2ef2277d1d6fc"
+  "gitHead": "fd72688e449d6dd3eafd346fc07879cb3bb01a4e"
 }