@tryghost/errors 1.1.1 → 1.2.0

package/lib/errors.js

@@ -1,7 +1,6 @@
 const uuid = require('uuid');
 const merge = require('lodash/merge');
 const isString = require('lodash/isString');
-const cloneDeep = require('lodash/cloneDeep');
 const utils = require('./utils');
 
 class GhostError extends Error {
@@ -71,34 +70,6 @@ class GhostError extends Error {
             });
         }
     }
-
-    prepareErrorForUser() {
-        const error = cloneDeep(this);
-
-        let stackbits = error.stack.split(/\n/);
-    
-        // We build this up backwards, so we always insert at position 1
-    
-        if (process.env.NODE_ENV === 'production') {
-            stackbits.splice(1, stackbits.length - 1);
-        } else {
-            // Clearly mark the strack trace
-            stackbits.splice(1, 0, `Stack Trace:`);
-        }
-    
-        // Add in our custom cotext and help methods
-    
-        if (this.help) {
-            stackbits.splice(1, 0, `${this.help}`);
-        }
-    
-        if (this.context) {
-            stackbits.splice(1, 0, `${this.context}`);
-        }
-    
-        error.stack = stackbits.join('\n');
-        return error;
-    }
 }
 
 const ghostErrors = {
@@ -349,5 +320,6 @@ const ghostErrorsWithBase = Object.assign({}, ghostErrors, {GhostError});
 module.exports.utils = {
     serialize: utils.serialize.bind(ghostErrorsWithBase),
     deserialize: utils.deserialize.bind(ghostErrorsWithBase),
-    isGhostError: utils.isGhostError.bind(ghostErrorsWithBase)
+    isGhostError: utils.isGhostError.bind(ghostErrorsWithBase),
+    prepareStackForUser: utils.prepareStackForUser
 };

package/lib/utils.js

@@ -183,6 +183,36 @@ exports.deserialize = function deserialize(errorFormat) {
     return internalError;
 };
 
+/**
+ * @description Replace the stack with a user-facing one
+ * @params {Error} err
+ */
+exports.prepareStackForUser = function prepareStackForUser(error) {
+    let stackbits = error.stack.split(/\n/);
+
+    // We build this up backwards, so we always insert at position 1
+
+    if (process.env.NODE_ENV === 'production') {
+        stackbits.splice(1, stackbits.length - 1);
+    } else {
+        // Clearly mark the strack trace
+        stackbits.splice(1, 0, `Stack Trace:`);
+    }
+
+    // Add in our custom cotext and help methods
+
+    if (this.help) {
+        stackbits.splice(1, 0, `${this.help}`);
+    }
+
+    if (this.context) {
+        stackbits.splice(1, 0, `${this.context}`);
+    }
+
+    error.stack = stackbits.join('\n');
+    return error;
+};
+
 /**
  * @description Check whether an error instance is a GhostError.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/errors",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "repository": "https://github.com/TryGhost/Utils/tree/main/packages/errors",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -28,5 +28,5 @@
     "lodash": "^4.17.21",
     "uuid": "^8.3.2"
   },
-  "gitHead": "deb1552864a7da3430e0f0854ff013b5d0aa4a0c"
+  "gitHead": "8ecf8264002298829fbce686a1bd0ad413e2e01b"
 }