loggable-error 1.0.0 → 1.0.2

package/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: Unit tests in CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/README.md

@@ -1,5 +1,7 @@
 # loggable-error
 
+![ci status](https://github.com/EvanK/npm-loggable-error/actions/workflows/ci.yml/badge.svg)
+
 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
@@ -30,3 +32,26 @@ Error: testing one two three
     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
     at node:internal/main/run_main_module:17:47
 ```
+
+## Stringification Options
+
+Our exported function accepts a second `options` argument, in case you want to control whether stack traces are displayed or the amount of starting indentation:
+
+```js
+stringify(e, { stack: false });
+// => 'Error: testing one two three'
+
+stringify(e, { depth: 8 });
+/* =>
+'        Error: testing one two three\n' +
+'            at Object.<anonymous> (/home/jdoe/test.js:7:9)\n' +
+'            at Module._compile (node:internal/modules/cjs/loader:1546:14)\n' +
+'            at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)\n' +
+'            at Module.load (node:internal/modules/cjs/loader:1317:32)\n' +
+'            at Module._load (node:internal/modules/cjs/loader:1127:12)\n' +
+'            at TracingChannel.traceSync (node:diagnostics_channel:315:14)\n' +
+'            at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)\n' +
+'            at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:166:5)\n' +
+'            at node:internal/main/run_main_module:30:49'
+*/
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loggable-error",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Stringifies errors into a format similar to console.log",
   "main": "./src/main.cjs",
   "exports": {

package/src/main.cjs

@@ -1,22 +1,35 @@
+const packageJson = require('../package.json');
+
 /**
  * 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}
+ * @param {object} [options]
+ * @param {number} [options.depth=0] Controls indentation of stack traces, properties and nested errors
+ * @param {boolean} [options.stack=true] Controls stack traces, displayed by default
+ * @returns {string} The stringified error
+ * @property {string} version
  */
-module.exports = function stringify (err, depth = 0) {
-  let collapsed = '';
+function stringify(err, options = {}) {
+  const depth = options.hasOwnProperty('depth') ? parseInt(options.depth, 10) : 0;
+  const stack = options.hasOwnProperty('stack') ? (!!options.stack) : true;
+
+  let collapsed = ' '.repeat(depth);
   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();
+    let body;
+    if (stack) {
+      // add full stack trace if one exists, otherwise convert to string
+      body = ( err?.stack ?? `${err}` ).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);
+      // replace error name with class constructor as necessary
+      if (body.startsWith('Error: ') && err.constructor.name != 'Error') {
+        body = err.constructor.name + body.substring(5);
+      }
+    } else {
+      body = `${err}`;
     }
-    collapsed += stack;
+    collapsed += body;
 
     const props = Object.getOwnPropertyNames(err);
 
@@ -39,7 +52,7 @@ module.exports = function stringify (err, depth = 0) {
 
         // if another error object, stringify it too
         if (err[property] instanceof Error) {
-          collapsed += stringify(err[property], depth + 2);
+          collapsed += stringify(err[property], { depth: depth + 2, stack }).trimStart();
         }
         // otherwise stringify as JSON
         else {
@@ -57,4 +70,6 @@ module.exports = function stringify (err, depth = 0) {
 
   return collapsed;
 }
+stringify.version = packageJson.version;
 
+module.exports = stringify;