feat(ut): added coverage tools

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
-build/
+build/
+coverage/

jest.config.js

@@ -1,13 +1,13 @@
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*.ts'],
+  coverageReporters: ['text', 'lcov'],
   preset: 'ts-jest',
   testEnvironment: 'node',
   roots: ['<rootDir>/test/'],
-  testMatch: [
-    '**/__tests__/**/*.+(ts|tsx|js)',
-    '**/?(*.)+(spec|test).+(ts|tsx|js)',
-  ],
+  testMatch: ['**/__tests__/**/*.+(ts|tsx|js)', '**/?(*.)+(spec|test).+(ts|tsx|js)'],
   transform: {
     '^.+\\.(ts|tsx)$': 'ts-jest',
   },
-};
+}

package.json

@@ -11,6 +11,7 @@
   "scripts": {
     "release": "np --any-branch --no-cleanup --no-tests --no-yarn",
     "test": "jest",
+    "coverage": "npm test -- --coverage",
     "lint": "eslint './src/**/*.ts'",
     "lint-windows": "eslint ./src/**/*.ts",
     "clean": "gts clean",

src/utils/functions/stringify.ts

@@ -28,12 +28,11 @@ const isObject = (val: unknown): boolean => {
  * @returns The string representation of the value.
  */
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
-export function safeStringify(val: any, options: stringifyOptions = defaultOptions): string | undefined {
+export function safeStringify(val: any, options: stringifyOptions = defaultOptions): string {
   const returnVal = stringifyHelper(val, false, options)
   if (returnVal !== undefined) {
     return '' + returnVal
   }
-  return undefined
 }
 
 /**
@@ -42,6 +41,7 @@ export function safeStringify(val: any, options: stringifyOptions = defaultOptio
  * @param value - The JSON string to parse.
  * @returns The parsed JSON object.
  */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function safeJsonParse(value: string): any {
   return JSON.parse(value, typeReviver)
 }

test/src/utils/functions/stringify.test.ts

@@ -317,4 +317,19 @@ describe('safeJsonParse', function () {
     const invalidStructureJson = '{"foo": [1, 2, {"dataType": "bi", "value": "invalid"}]}'
     expect(() => safeJsonParse(invalidStructureJson)).toThrowError()
   })
+
+  it('complex nested object test', () => {
+    const nestedObject = { a: { b: { c: [1, 2, { d: 'test' }], e: { f: 'test' } } } }
+    expect(safeJsonParse(safeStringify(nestedObject))).toEqual(nestedObject)
+  })
+
+  it('buffer compatibility test with JSON.stringify', () => {
+    const buffer = Buffer.from('hello')
+    const obj = {
+      buf: buffer,
+    }
+    expect(safeJsonParse(JSON.stringify(obj))).toEqual({
+      buf: { type: 'Buffer', data: [104, 101, 108, 108, 111] },
+    })
+  })
 })