loggable-error 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Evan Kaufman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+# loggable-error
+
+In those times when you need to log an error to somewhere other than standard output, this simple module stringifies Error objects in a format akin to `console.log`:
+
+```js
+// supports cjs require
+const stringify = require('loggable-error');
+// or esm import
+// import stringify from 'loggable-error';
+
+try {
+  throw new Error('testing one two three');
+} catch(e) {
+  fs.writeFileSync(
+    '/home/jdoe/log.txt',
+    stringify(e)
+  );
+}
+```
+
+Open up said file and you'll find something along the lines of:
+
+```
+Error: testing one two three
+    at Object.<anonymous> (/home/jdoe/test.js:7:9)
+    at Module._compile (node:internal/modules/cjs/loader:1126:14)
+    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1180:10)
+    at Module.load (node:internal/modules/cjs/loader:1004:32)
+    at Function.Module._load (node:internal/modules/cjs/loader:839:12)
+    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
+    at node:internal/main/run_main_module:17:47
+```

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "loggable-error",
+  "version": "1.0.0",
+  "description": "Stringifies errors into a format similar to console.log",
+  "main": "./src/main.cjs",
+  "exports": {
+    "import": "./src/import.mjs",
+    "require": "./src/main.cjs"
+  },
+  "type": "module",
+  "scripts": {
+    "test": "mocha ./tests/*.test.*js"
+  },
+  "author": "Evan Kaufman <evan@evanskaufman.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "chai": "^5.1.1",
+    "mocha": "^10.7.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EvanK/npm-loggable-error.git"
+  },
+  "keywords": [
+    "error",
+    "exception",
+    "log",
+    "loggable",
+    "stringify"
+  ],
+  "bugs": {
+    "url": "https://github.com/EvanK/npm-loggable-error/issues"
+  },
+  "homepage": "https://github.com/EvanK/npm-loggable-error#readme"
+}

package/src/import.mjs

@@ -0,0 +1,3 @@
+// ESM support
+import stringify from './main.cjs';
+export default stringify;

package/src/main.cjs

@@ -0,0 +1,60 @@
+/**
+ * Converts any Error instance to a string format similar to what console.log generates.
+ * Any other value will be cast to string.
+ * 
+ * @param {*} err The error to stringify
+ * @param {number} depth For recursive calls on nested error objects, controls indentation
+ * @returns {string}
+ */
+module.exports = function stringify (err, depth = 0) {
+  let collapsed = '';
+  if (err instanceof Error) {
+    // add full stack trace if one exists, otherwise convert to string
+    let stack = ( err?.stack ?? err.toString() ).replace(/^/gm, ' '.repeat(depth)).trim();
+
+    // replace error name with class constructor as necessary
+    if (stack.startsWith('Error: ') && err.constructor.name != 'Error') {
+      stack = err.constructor.name + stack.substring(5);
+    }
+    collapsed += stack;
+
+    const props = Object.getOwnPropertyNames(err);
+
+    // skip these two ahead of time
+    for (const skipped of ['message','stack']) {
+      const propAt = props.indexOf(skipped);
+      if (propAt > -1) props.splice(propAt, 1);
+    }
+
+    // only break into object notation if we have addtl props to dump
+    if (props.length) {
+      const dedent = ' '.repeat(depth);
+      const indent = ' '.repeat(depth + 2);
+
+      collapsed += ' {\n';
+
+      // loop and print each (indented) prop name
+      for (let property of props) {
+        collapsed += `${indent}[${property}]: `;
+
+        // if another error object, stringify it too
+        if (err[property] instanceof Error) {
+          collapsed += stringify(err[property], depth + 2);
+        }
+        // otherwise stringify as JSON
+        else {
+          collapsed += JSON.stringify(err[property]);
+        }
+
+        collapsed += '\n';
+      }
+
+      collapsed += `${dedent}}\n`;
+    }
+  } else {
+    collapsed += err;
+  }
+
+  return collapsed;
+}
+