update name of jsonStringifySafe

hiro5id · May 26, 2023 · 06da04d · 06da04d
1 parent 035e79b
commit 06da04d
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 11 deletions.
diff --git a/src/colors/colorize.ts b/src/colors/colorize.ts
@@ -1,4 +1,4 @@
-import { stringify } from '../json-stringify-safe/stringify-safe';
+import { jsonStringifySafe } from '../json-stringify-safe/stringify-safe';
 
 export interface IDefaultColorMap {
   black: string;
@@ -127,8 +127,8 @@ export function colorJson(jsonInput: any, colorsInput: Partial<IColorConfigurati
   let isWarnLevel = false;
   let json: string;
   if (supportsColor()) {
-    if (typeof jsonInput !== 'string') json = stringify(jsonInput, undefined, spacing);
-    else json = stringify(JSON.parse(jsonInput), undefined, spacing);
+    if (typeof jsonInput !== 'string') json = jsonStringifySafe(jsonInput, undefined, spacing);
+    else json = jsonStringifySafe(JSON.parse(jsonInput), undefined, spacing);
     return (
       (colorMap as any)[colors.separator] +
       json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, (match: string) => {
@@ -205,8 +205,8 @@ export function colorJson(jsonInput: any, colorsInput: Partial<IColorConfigurati
       '\x1b[0m'
     );
   } else {
-    if (typeof jsonInput !== 'string') json = stringify(jsonInput, undefined, spacing);
-    else json = stringify(JSON.parse(jsonInput), undefined, spacing);
+    if (typeof jsonInput !== 'string') json = jsonStringifySafe(jsonInput, undefined, spacing);
+    else json = jsonStringifySafe(JSON.parse(jsonInput), undefined, spacing);
     return json;
   }
 }
diff --git a/src/json-stringify-safe/stringify-safe.ts b/src/json-stringify-safe/stringify-safe.ts
@@ -1,6 +1,15 @@
 export type EntryProcessor = (key: string, value: any) => any;
 
-export function stringify(obj: any, serializer?: EntryProcessor, indent?: string | number, decycler?: EntryProcessor): string {
+/**
+ *  Stringifies JSON objects into strings in a safe way so that it can handle recursion and cyclical references
+ *
+ * @param obj the object to serialize
+ * @param serializer custom serializer
+ * @param indent indent for JSON formatting
+ * @param decycler a function to use when a cyclical refernce is found
+ * @returns the JSON string represantation
+ */
+export function jsonStringifySafe(obj: any, serializer?: EntryProcessor, indent?: string | number, decycler?: EntryProcessor): string {
   const foo = getSerialize(serializer, decycler);
   return JSON.stringify(obj, foo as any, indent);
 }

diff --git a/src/logger.ts b/src/logger.ts
@@ -12,7 +12,7 @@ import { ToOneLine } from './to-one-line';
 import { Env } from './env';
 import { NewLineCharacter } from './new-line-character';
 import { colorJson } from './colors/colorize';
-import { stringify } from './json-stringify-safe/stringify-safe';
+import { jsonStringifySafe } from './json-stringify-safe/stringify-safe';
 
 // tslint:disable-next-line:no-var-requires
 require('source-map-support').install({
@@ -219,7 +219,7 @@ export function FormatErrorObject(object: any) {
   if (CONSOLE_LOG_COLORIZE && CONSOLE_LOG_COLORIZE.toLowerCase() === 'true') {
     return `${colorJson(returnData)}${endOfLogCharacter}`;
   } else {
-    const jsonString = stringify(returnData);
+    const jsonString = jsonStringifySafe(returnData);
     return `${jsonString}${endOfLogCharacter}`;
   }
 }

diff --git a/src/safe-object-assign.ts b/src/safe-object-assign.ts
@@ -1,4 +1,4 @@
-import { stringify } from './json-stringify-safe/stringify-safe';
+import { jsonStringifySafe } from './json-stringify-safe/stringify-safe';
 import { sortObject } from './sort-object';
 // tslint:disable-next-line:no-var-requires
 /* tslint:disable:only-arrow-functions */
@@ -62,8 +62,8 @@ export function safeObjectAssign(target: any, mergeStringProperties: string[], .
     return mergeDeep(theTarget, ...theSources);
   }
 
-  const targetCopy = JSON.parse(stringify(target));
-  const sourcesCopy = JSON.parse(stringify(sources));
+  const targetCopy = JSON.parse(jsonStringifySafe(target));
+  const sourcesCopy = JSON.parse(jsonStringifySafe(sources));
 
   return mergeDeep(targetCopy, ...sourcesCopy);
 }