feat(internal): prepareStackTrace

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

.eslintrc.base.cjs

@@ -676,7 +676,7 @@ const config = {
         '@typescript-eslint/no-base-to-string': [
           2,
           {
-            ignoredTypeNames: ['RegExp']
+            ignoredTypeNames: ['Error', 'RegExp', 'URL', 'URLSearchParams']
           }
         ],
         '@typescript-eslint/no-floating-promises': [

__tests__/setup/chai.ts

@@ -5,7 +5,15 @@
  */
 
 import chai from 'chai'
+import chaiString from 'chai-string'
 
 // configure chai
 chai.config.includeStack = true
 chai.config.truncateThreshold = 0
+
+/**
+ * initialize chai plugins.
+ *
+ * @see https://github.com/onechiporenko/chai-string
+ */
+chai.use(chaiString)

package.json

@@ -75,6 +75,7 @@
     "@flex-development/tutils": "6.0.0-alpha.7",
     "@graphql-eslint/eslint-plugin": "3.13.0",
     "@types/chai": "4.3.4",
+    "@types/chai-string": "1.4.2",
     "@types/conventional-changelog": "3.1.1",
     "@types/conventional-changelog-config-spec": "2.1.2",
     "@types/conventional-changelog-writer": "4.0.1",
@@ -92,6 +93,7 @@
     "@vitest/coverage-c8": "0.26.2",
     "@vitest/ui": "0.26.2",
     "chai": "4.3.7",
+    "chai-string": "1.5.0",
     "conventional-changelog-cli": "2.2.2",
     "conventional-recommended-bump": "6.1.0",
     "cspell": "6.18.0",

src/internal/__tests__/prepare-stack-trace.spec.ts

@@ -0,0 +1,21 @@
+/**
+ * @file Unit Tests - prepareStackTrace
+ * @module create-error-node/internal/tests/unit/prepareStackTrace
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { NodeError } from '#src/types'
+import testSubject from '../prepare-stack-trace'
+
+describe('unit:internal/prepareStackTrace', () => {
+  it('should return error with new stack trace', () => {
+    // Arrange
+    const error: NodeError<TypeError> = Object.assign(new Error(), {
+      code: ErrorCode.ERR_INSPECTOR_NOT_WORKER,
+      message: 'Current thread is not a worker'
+    })
+
+    // Act + Expect
+    expect(testSubject(error).stack).to.startWith(error.toString())
+  })
+})

src/internal/prepare-stack-trace.ts

@@ -0,0 +1,33 @@
+/**
+ * @file Internal - prepareStackTrace
+ * @module create-node-error/internal/prepareStackTrace
+ */
+
+import type { NodeError } from '#src/types'
+
+/**
+ * Adds a stack trace to the given `error`.
+ *
+ * Does not preserve previously written traces.
+ *
+ * @template T - Error base type
+ *
+ * @param {NodeError<T>} error - Error to evaluate
+ * @return {NodeError<T>} `error` with new stack trace
+ */
+function prepareStackTrace<T extends Error = Error>(
+  error: NodeError<T>
+): NodeError<T> {
+  // add stack trace
+  Error.captureStackTrace(error, prepareStackTrace)
+
+  // make sure stack trace is formatted properly
+  error.stack = error.stack!.replace(
+    new RegExp(`^${error.name}: ${error.message}`),
+    error.toString()
+  )
+
+  return error
+}
+
+export default prepareStackTrace

yarn.lock

@@ -1002,6 +1002,7 @@ __metadata:
     "@flex-development/tutils": "npm:6.0.0-alpha.7"
     "@graphql-eslint/eslint-plugin": "npm:3.13.0"
     "@types/chai": "npm:4.3.4"
+    "@types/chai-string": "npm:1.4.2"
     "@types/conventional-changelog": "npm:3.1.1"
     "@types/conventional-changelog-config-spec": "npm:2.1.2"
     "@types/conventional-changelog-writer": "npm:4.0.1"
@@ -1019,6 +1020,7 @@ __metadata:
     "@vitest/coverage-c8": "npm:0.26.2"
     "@vitest/ui": "npm:0.26.2"
     chai: "npm:4.3.7"
+    chai-string: "npm:1.5.0"
     conventional-changelog-cli: "npm:2.2.2"
     conventional-recommended-bump: "npm:6.1.0"
     cspell: "npm:6.18.0"
@@ -1738,6 +1740,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/chai-string@npm:1.4.2":
+  version: 1.4.2
+  resolution: "@types/chai-string@npm:1.4.2"
+  dependencies:
+    "@types/chai": "npm:*"
+  checksum: c272b47a9ee36ec43b337ac4995f4b0d6f942b4042c464a9211efae8cebeaa07212e06ff6196d397e44c7c3996f79ba67a0d3733c2989eb55ee71c0bb2f2ca26
+  languageName: node
+  linkType: hard
+
 "@types/chai-subset@npm:^1.3.3":
   version: 1.3.3
   resolution: "@types/chai-subset@npm:1.3.3"
@@ -2689,6 +2700,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"chai-string@npm:1.5.0":
+  version: 1.5.0
+  resolution: "chai-string@npm:1.5.0"
+  peerDependencies:
+    chai: ^4.1.2
+  checksum: d39e07eb8311f99130c3fd404ef86bc09b4b4b4da153d61ec80875da48d06ead90fafd13692eaf3197b672679212603cd4e9dd3b9f30313d6f6fa56d40ac7517
+  languageName: node
+  linkType: hard
+
 "chai@npm:4.3.7, chai@npm:^4.3.7":
   version: 4.3.7
   resolution: "chai@npm:4.3.7"