nightingale-formatter 12.1.4 → 14.0.0

package/CHANGELOG.md

@@ -3,6 +3,47 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [14.0.0](https://github.com/christophehurpeau/nightingale/compare/v13.0.0...v14.0.0) (2023-06-30)
+
+
+### ⚠ BREAKING CHANGES
+
+* **deps:** require node 18 
+* requires node 18
+
+### Features
+
+* requires node 18 ([4452b11](https://github.com/christophehurpeau/nightingale/commit/4452b116188e58c293be85e462e04922f7ad51f0))
+
+
+### Miscellaneous Chores
+
+* **deps:** update dependency @pob/root to v8 ([#760](https://github.com/christophehurpeau/nightingale/issues/760)) ([22dc3cc](https://github.com/christophehurpeau/nightingale/commit/22dc3cceabdfd465d04ee36fec8fdac31febab69))
+
+
+
+# [13.0.0](https://github.com/christophehurpeau/nightingale/compare/v12.1.4...v13.0.0) (2022-11-19)
+
+
+### Code Refactoring
+
+* drop node 14 and cjs ([9a8ca06](https://github.com/christophehurpeau/nightingale/commit/9a8ca064449ddc0d69e26543e21c2d522536c50a))
+
+
+### Features
+
+* build for node 16 ([30ae3e9](https://github.com/christophehurpeau/nightingale/commit/30ae3e9c455dbad793c2f704b9d860069dc80c32))
+
+
+### BREAKING CHANGES
+
+* dropped node 14 and cjs
+* drop node 14
+
+
+
+
+
 ## [12.1.4](https://github.com/christophehurpeau/nightingale/compare/v12.1.3...v12.1.4) (2022-02-05)
 
 

package/README.md

@@ -8,6 +8,10 @@
 
 <p align="center">
   <a href="https://npmjs.org/package/nightingale-formatter"><img src="https://img.shields.io/npm/v/nightingale-formatter.svg?style=flat-square"></a>
+  <a href="https://npmjs.org/package/nightingale-formatter"><img src="https://img.shields.io/npm/dw/nightingale-formatter.svg?style=flat-square"></a>
+  <a href="https://npmjs.org/package/nightingale-formatter"><img src="https://img.shields.io/node/v/nightingale-formatter.svg?style=flat-square"></a>
+  <a href="https://npmjs.org/package/nightingale-formatter"><img src="https://img.shields.io/npm/types/nightingale-formatter.svg?style=flat-square"></a>
+  <a href="https://codecov.io/gh/christophehurpeau/nightingale"><img src="https://img.shields.io/codecov/c/github/christophehurpeau/nightingale/master.svg?style=flat-square"></a>
 </p>
 
 ## Install

package/dist/{formatObject.d.ts → definitions/formatObject.d.ts}

@@ -3,7 +3,7 @@ export interface FormatObjectOptions {
     padding?: string;
     maxDepth?: number;
 }
-export declare type StyleFn = (styles: Styles, value: string) => string;
-export declare type ObjectStyles<Keys extends string = string> = Record<Keys, Styles>;
+export type StyleFn = (styles: Styles, value: string) => string;
+export type ObjectStyles<Keys extends string = string> = Record<Keys, Styles>;
 export declare function formatObject(object: Record<string, unknown>, styleFn?: StyleFn, objectStyles?: ObjectStyles, { padding, maxDepth }?: FormatObjectOptions): string;
 //# sourceMappingURL=formatObject.d.ts.map

package/dist/definitions/formatObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatObject.d.ts","sourceRoot":"","sources":["../../src/formatObject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,OAAO,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;AAEhE,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAya9E,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,GAAE,OAAmB,EAC5B,YAAY,CAAC,EAAE,YAAY,EAC3B,EAAE,OAAc,EAAE,QAAa,EAAE,GAAE,mBAAwB,GAC1D,MAAM,CAkBR"}

package/dist/definitions/formatObject.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=formatObject.test.d.ts.map

package/dist/definitions/formatObject.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatObject.test.d.ts","sourceRoot":"","sources":["../../src/formatObject.test.ts"],"names":[],"mappings":""}

package/dist/definitions/formatRecordToString.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatRecordToString.d.ts","sourceRoot":"","sources":["../../src/formatRecordToString.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,gBAAgB,CAAC;AAK5D,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,QAAQ,EACrD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,KAAK,EAAE,OAAO,GACb,MAAM,CAyDR"}

package/dist/definitions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACL,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/definitions/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/definitions/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/index.test.ts"],"names":[],"mappings":""}

package/dist/definitions/levelToStyles.d.ts

@@ -0,0 +1,3 @@
+export type LevelToStyles = Readonly<Record<number, string[]>>;
+export declare const levelToStyles: LevelToStyles;
+//# sourceMappingURL=levelToStyles.d.ts.map

package/dist/definitions/levelToStyles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"levelToStyles.d.ts","sourceRoot":"","sources":["../../src/levelToStyles.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;AAE/D,eAAO,MAAM,aAAa,EAAE,aAS3B,CAAC"}

package/dist/definitions/levelToSymbol.d.ts

@@ -0,0 +1,3 @@
+export type LevelToSymbol = Readonly<Record<number, string>>;
+export declare const levelToSymbol: LevelToSymbol;
+//# sourceMappingURL=levelToSymbol.d.ts.map

package/dist/definitions/levelToSymbol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"levelToSymbol.d.ts","sourceRoot":"","sources":["../../src/levelToSymbol.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE7D,eAAO,MAAM,aAAa,EAAE,aAS3B,CAAC"}

package/dist/definitions/styleToHexColor.d.ts

@@ -0,0 +1,3 @@
+export type StyleToHexColor = Readonly<Record<string, string>>;
+export declare const styleToHexColor: StyleToHexColor;
+//# sourceMappingURL=styleToHexColor.d.ts.map

package/dist/definitions/styleToHexColor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styleToHexColor.d.ts","sourceRoot":"","sources":["../../src/styleToHexColor.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE/D,eAAO,MAAM,eAAe,EAAE,eAI7B,CAAC"}

package/dist/{styleToHtmlStyle.d.ts → definitions/styleToHtmlStyle.d.ts}

@@ -2,7 +2,7 @@ export interface HtmlStyle {
     readonly open: string;
     readonly close: string;
 }
-export declare type StyleToHtmlStyle = Readonly<Record<string, HtmlStyle>>;
+export type StyleToHtmlStyle = Readonly<Record<string, HtmlStyle>>;
 export declare const styleToHtmlStyleThemeLight: StyleToHtmlStyle;
 export declare const styleToHtmlStyleThemeDark: StyleToHtmlStyle;
 //# sourceMappingURL=styleToHtmlStyle.d.ts.map

package/dist/definitions/styleToHtmlStyle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styleToHtmlStyle.d.ts","sourceRoot":"","sources":["../../src/styleToHtmlStyle.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;AAEnE,eAAO,MAAM,0BAA0B,EAAE,gBAgDxC,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,gBAOvC,CAAC"}

package/dist/index-browser.es.js

@@ -128,10 +128,10 @@ var styleToHtmlStyleThemeDark = _extends({}, styleToHtmlStyleThemeLight, {
 });
 
 /* eslint-disable max-lines, @typescript-eslint/no-use-before-define */
+
 var noStyleFn = function noStyleFn(styles, value) {
   return value;
 };
-
 function tryStringify(arg) {
   try {
     return JSON.stringify(arg).replace(/\\n/g, '\n');
@@ -139,21 +139,21 @@ function tryStringify(arg) {
     return '[Circular]';
   }
 }
-
 var sameRawFormattedValue = function sameRawFormattedValue(value) {
   return {
     stringValue: value,
     formattedValue: value
   };
 };
-
 function internalFormatValue(value, styleFn, styles, _ref) {
   var padding = _ref.padding,
-      depth = _ref.depth,
-      maxDepth = _ref.maxDepth,
-      objects = _ref.objects;
+    depth = _ref.depth,
+    maxDepth = _ref.maxDepth,
+    objects = _ref.objects,
+    stack,
+    name,
+    _name;
   var typeofValue = typeof value;
-
   if (!styles) {
     if (value == null) {
       styles = ['cyan'];
@@ -162,32 +162,25 @@ function internalFormatValue(value, styleFn, styles, _ref) {
         case 'undefined':
           styles = ['cyan'];
           break;
-
         case 'boolean':
           styles = ['green'];
           break;
-
         case 'number':
           styles = ['yellow'];
           break;
-
         case 'bigint':
           styles = ['red'];
           break;
-
         case 'string':
           styles = ['orange'];
           break;
-
         case 'symbol':
           styles = ['magenta'];
           break;
       }
     }
   }
-
   var stringValue;
-
   if (value === null) {
     stringValue = 'null';
   } else if (value === undefined) {
@@ -218,11 +211,10 @@ function internalFormatValue(value, styleFn, styles, _ref) {
       });
     }
   } else if (value instanceof Error) {
-    var stack = value.stack;
+    stack = value.stack;
     stringValue = stack != null && stack.startsWith(value.message) ? stack : value.message + "\n" + (stack || '');
   } else if (value instanceof Map) {
-    var name = value.constructor.name;
-
+    name = value.constructor.name;
     if (depth >= maxDepth) {
       stringValue = "{" + name + "...}";
     } else {
@@ -238,8 +230,7 @@ function internalFormatValue(value, styleFn, styles, _ref) {
   } else if (typeofValue === 'symbol') {
     stringValue = value.toString();
   } else if (value instanceof Set) {
-    var _name = value.constructor.name;
-
+    _name = value.constructor.name;
     if (depth >= maxDepth) {
       stringValue = "{" + _name + "...}";
     } else {
@@ -257,88 +248,78 @@ function internalFormatValue(value, styleFn, styles, _ref) {
   } else {
     stringValue = tryStringify(value);
   }
-
   var formattedValue = styleFn(styles, stringValue);
   return {
     stringValue: stringValue,
     formattedValue: formattedValue
   };
 }
-
 var separator = ',';
-
 var internalFormatKey = function internalFormatKey(key, styleFn) {
   return {
     stringKey: key + ": ",
     formattedKey: styleFn(['gray-light', 'bold'], key + ":") + " "
   };
 };
-
 var internalNoKey = function internalNoKey() {
   return {
     stringKey: '',
     formattedKey: ''
   };
 };
-
 var internalFormatMapKey = function internalFormatMapKey(key, styleFn, internalFormatParams) {
   var _internalFormatValue = internalFormatValue(key, noStyleFn, undefined, internalFormatParams),
-      stringValue = _internalFormatValue.stringValue,
-      formattedValue = _internalFormatValue.formattedValue;
-
+    stringValue = _internalFormatValue.stringValue,
+    formattedValue = _internalFormatValue.formattedValue;
   return {
     stringKey: stringValue + " => ",
     formattedKey: styleFn(['gray-light', 'bold'], formattedValue + ":") + " "
   };
 };
-
 var internalFormatIterator = function internalFormatIterator(values, styleFn, objectStyles, _ref2, _ref3) {
   var padding = _ref2.padding,
-      depth = _ref2.depth,
-      maxDepth = _ref2.maxDepth,
-      objects = _ref2.objects;
+    depth = _ref2.depth,
+    maxDepth = _ref2.maxDepth,
+    objects = _ref2.objects;
   var prefix = _ref3.prefix,
-      suffix = _ref3.suffix,
-      _ref3$prefixSuffixSpa = _ref3.prefixSuffixSpace,
-      prefixSuffixSpace = _ref3$prefixSuffixSpa === void 0 ? ' ' : _ref3$prefixSuffixSpa,
-      formatKey = _ref3.formatKey;
+    suffix = _ref3.suffix,
+    _ref3$prefixSuffixSpa = _ref3.prefixSuffixSpace,
+    prefixSuffixSpace = _ref3$prefixSuffixSpa === void 0 ? ' ' : _ref3$prefixSuffixSpa,
+    formatKey = _ref3.formatKey;
   var breakLine = false;
-
   var formattedSeparator = function formattedSeparator() {
     return styleFn(['gray'], separator);
   };
-
   var valuesMaxIndex = values.length - 1;
   var formattedValues = values.map(function (_ref4, index) {
     var key = _ref4.key,
-        value = _ref4.value;
+      value = _ref4.value;
     var internalFormatParams = {
       padding: padding,
       depth: depth + 1,
       maxDepth: maxDepth,
       objects: objects
-    }; // key must be formatted before value (browser-formatter needs order)
+    };
 
+    // key must be formatted before value (browser-formatter needs order)
     var _formatKey = formatKey(key, styleFn, internalFormatParams),
-        stringKey = _formatKey.stringKey,
-        formattedKey = _formatKey.formattedKey;
-
+      stringKey = _formatKey.stringKey,
+      formattedKey = _formatKey.formattedKey;
     var _internalFormatValue2 = internalFormatValue(value, styleFn, key && objectStyles ? objectStyles[key] : undefined, internalFormatParams),
-        stringValue = _internalFormatValue2.stringValue,
-        formattedValue = _internalFormatValue2.formattedValue;
-
+      stringValue = _internalFormatValue2.stringValue,
+      formattedValue = _internalFormatValue2.formattedValue;
     if (stringValue && (stringValue.length > 80 || stringValue.includes('\n'))) {
       breakLine = true;
       stringValue = stringValue.replace(/\n/g, "\n" + padding);
       formattedValue = formattedValue.replace(/\n/g, "\n" + padding);
     }
-
     return {
       stringValue: stringKey + stringValue + (index === valuesMaxIndex ? '' : separator),
-      formattedValue: formattedKey + formattedValue + (index === valuesMaxIndex ? '' : formattedSeparator()) // note: we need to format the separator for each values for browser-formatter
-
+      formattedValue: formattedKey + formattedValue + (index === valuesMaxIndex ? '' : formattedSeparator())
+      // note: we need to format the separator for each values for browser-formatter
     };
   });
+
   return {
     stringValue: prefix + formattedValues.map(breakLine ? function (v) {
       return "\n" + padding + v.stringValue;
@@ -352,23 +333,18 @@ var internalFormatIterator = function internalFormatIterator(values, styleFn, ob
     }).join(breakLine ? '' : ' ') + (breakLine ? ',\n' : prefixSuffixSpace) + suffix
   };
 };
-
 function internalFormatObject(object, styleFn, objectStyles, _ref5) {
   var padding = _ref5.padding,
-      depth = _ref5.depth,
-      maxDepth = _ref5.maxDepth,
-      objects = _ref5.objects;
-
+    depth = _ref5.depth,
+    maxDepth = _ref5.maxDepth,
+    objects = _ref5.objects;
   if (objects.has(object)) {
     return sameRawFormattedValue('{Circular Object}');
   }
-
   var keys = Object.keys(object);
-
   if (keys.length === 0) {
     return sameRawFormattedValue('{}');
   }
-
   objects.add(object);
   var result = internalFormatIterator(keys.map(function (key) {
     return {
@@ -388,23 +364,18 @@ function internalFormatObject(object, styleFn, objectStyles, _ref5) {
   objects.delete(object);
   return result;
 }
-
 function internalFormatMap(name, map, styleFn, _ref6) {
   var padding = _ref6.padding,
-      depth = _ref6.depth,
-      maxDepth = _ref6.maxDepth,
-      objects = _ref6.objects;
-
+    depth = _ref6.depth,
+    maxDepth = _ref6.maxDepth,
+    objects = _ref6.objects;
   if (objects.has(map)) {
     return sameRawFormattedValue("{Circular " + name + "}");
   }
-
   var keys = [].concat(map.keys());
-
   if (keys.length === 0) {
     return sameRawFormattedValue(name + " {}");
   }
-
   objects.add(map);
   var result = internalFormatIterator(keys.map(function (key) {
     return {
@@ -424,21 +395,17 @@ function internalFormatMap(name, map, styleFn, _ref6) {
   objects.delete(map);
   return result;
 }
-
 function internalFormatArray(array, styleFn, _ref7) {
   var padding = _ref7.padding,
-      depth = _ref7.depth,
-      maxDepth = _ref7.maxDepth,
-      objects = _ref7.objects;
-
+    depth = _ref7.depth,
+    maxDepth = _ref7.maxDepth,
+    objects = _ref7.objects;
   if (objects.has(array)) {
     return sameRawFormattedValue('{Circular Array}');
   }
-
   if (array.length === 0) {
     return sameRawFormattedValue('[]');
   }
-
   objects.add(array);
   var result = internalFormatIterator(array.map(function (value) {
     return {
@@ -459,23 +426,18 @@ function internalFormatArray(array, styleFn, _ref7) {
   objects.delete(array);
   return result;
 }
-
 function internalFormatSet(name, set, styleFn, _ref8) {
   var padding = _ref8.padding,
-      depth = _ref8.depth,
-      maxDepth = _ref8.maxDepth,
-      objects = _ref8.objects;
-
+    depth = _ref8.depth,
+    maxDepth = _ref8.maxDepth,
+    objects = _ref8.objects;
   if (objects.has(set)) {
     return sameRawFormattedValue("{Circular " + name + "}");
   }
-
   var values = [].concat(set.values());
-
   if (values.length === 0) {
     return sameRawFormattedValue(name + " []");
   }
-
   objects.add(set);
   var result = internalFormatIterator(values.map(function (value) {
     return {
@@ -495,42 +457,35 @@ function internalFormatSet(name, set, styleFn, _ref8) {
   objects.delete(set);
   return result;
 }
-
 function formatObject(object, styleFn, objectStyles, _temp) {
   if (styleFn === void 0) {
     styleFn = noStyleFn;
   }
-
   var _ref9 = _temp === void 0 ? {} : _temp,
-      _ref9$padding = _ref9.padding,
-      padding = _ref9$padding === void 0 ? '  ' : _ref9$padding,
-      _ref9$maxDepth = _ref9.maxDepth,
-      maxDepth = _ref9$maxDepth === void 0 ? 10 : _ref9$maxDepth;
-
+    _ref9$padding = _ref9.padding,
+    padding = _ref9$padding === void 0 ? '  ' : _ref9$padding,
+    _ref9$maxDepth = _ref9.maxDepth,
+    maxDepth = _ref9$maxDepth === void 0 ? 10 : _ref9$maxDepth;
   var _internalFormatObject = internalFormatObject(object, styleFn, objectStyles, {
-    padding: padding,
-    maxDepth: maxDepth,
-    depth: 0,
-    objects: new Set()
-  }),
-      result = _internalFormatObject.formattedValue;
-
+      padding: padding,
+      maxDepth: maxDepth,
+      depth: 0,
+      objects: new Set()
+    }),
+    result = _internalFormatObject.formattedValue;
   if (result === '{}') {
     return '';
   }
-
   return result;
 }
 
 function formatRecordToString(record, style) {
   var parts = [];
-
   if (record.displayName) {
     parts.push(style(['gray-light'], record.displayName));
   } else if (record.key) {
     parts.push(style(['gray-light'], record.key));
   }
-
   if (record.datetime) {
     parts.push(style(['gray', 'bold'], record.datetime.toTimeString().split(' ')[0]));
     /* new Date().toFormat('HH24:MI:SS') */
@@ -538,7 +493,6 @@ function formatRecordToString(record, style) {
 
   var message = record.symbol || levelToSymbol[record.level];
   var styles = record.styles || levelToStyles[record.level];
-
   if (record.message) {
     if (message) {
       message += " " + record.message;
@@ -546,29 +500,22 @@ function formatRecordToString(record, style) {
       message = record.message;
     }
   }
-
   if (message) {
     if (styles) {
       message = style(styles, message);
     }
-
     parts.push(message);
   }
-
   var formatRecordObject = function formatRecordObject(key, object, objectStyles) {
     if (!object) {
       return;
     }
-
     var stringObject = formatObject(object, style, objectStyles);
-
     if (!stringObject) {
       return;
     }
-
     parts.push(stringObject);
   };
-
   formatRecordObject('metadata', record.metadata, record.metadataStyles);
   formatRecordObject('extra', record.extra, undefined);
   formatRecordObject('context', record.context, undefined);