Better error reporting

Author: Aetf

package-lock.json

@@ -49,6 +49,7 @@
         "sass-loader": "^11.0.1",
         "strip-indent": "^3.0.0",
         "style-loader": "^2.0.0",
+        "verror": "^1.10.0",
         "webpack": "^5.28.0"
     },
     "peerDependencies": {

package.json

@@ -6,6 +6,7 @@ const chalk = require('chalk');
 const _ = require('lodash');
 const stripIndent = require('strip-indent');
 const bibtex = require('@retorquere/bibtex-parser');
+const { MultiError } = require('verror');
 
 const { PublistStrictAbort } = require('./consts');
 
@@ -35,19 +36,19 @@ async function allSettled(promises) {
 }
 
 function reportErrors(ctx, errors) {
-    let hasError = false;
+    let bibErrors = [];
     for (const err of errors) {
         if (err instanceof BibRendererError) {
-            hasError = true;
             for (const inner of err.errors) {
                 ctx.log.error(inner);
             }
+            bibErrors.push(err);
         } else {
             // re-raise anything else, which should be fatal.
             throw err;
         }
     }
-    return hasError;
+    return bibErrors;
 }
 
 class BibtexParseError extends Error {
@@ -93,20 +94,20 @@ class BibRendererError extends Error {
 }
 
 async function bibRenderer(ctx, opts, { path, text }) {
-    let hasError = false;
+    let bibErrors = [];
     path = pathFn.relative(ctx.source_dir, path);
 
     // parse content as bibtex
     const [ entries, errors ] = await parseBibEntries(ctx, opts, { path, text });
-    hasError |= reportErrors(ctx, errors);
+    bibErrors.push(...reportErrors(ctx, errors));
 
     // construct list of items
     const [items, itemErrors] = await allSettled(entries.map(entry => itemFromEntry(ctx, opts, entry)));
-    hasError |= reportErrors(ctx, itemErrors);
+    bibErrors.push(...reportErrors(ctx, itemErrors));
 
-    if (hasError) {
+    if (bibErrors.length > 0) {
         if (opts.strict) {
-            throw new PublistStrictAbort(path);
+            throw new PublistStrictAbort(path, new MultiError(bibErrors));
         } else {
             ctx.log.warn(`${path}: there were errors while loading, bib entries may be incomplete.`);
         }

src/bib-renderer.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const pathFn = require('path');
+const { VError, WError } = require('verror');
 
 module.exports.SELF = pathFn.resolve(__dirname, '..');
 module.exports.TEMPLATE_DIR = pathFn.resolve(__dirname, '../templates');
@@ -22,20 +23,26 @@ module.exports.DEFAULT_INSTOPTS = {
     venues: {},
 }
 
-class PublistStrictAbort extends Error {
-    constructor(file) {
-        super(`'${file}': aborting because there were errors and the strict mode is enabled`);
-        this.name = 'PublistStrictAbort';
-        Error.captureStackTrace(this, PublistStrictAbort);
+class PublistStrictAbort extends VError {
+    constructor(file, cause, info) {
+        super({
+            name: 'PublistStrictAbort',
+            cause,
+            info,
+            constructorOpt: PublistStrictAbort,
+        }, `'${file}': aborting because there were errors and the strict mode is enabled`);
     }
 }
 module.exports.PublistStrictAbort = PublistStrictAbort;
 
-class PublistWebpackError extends Error {
-    constructor() {
-        super(`Aborting because there were errors when webpacking`);
-        this.name = 'PublistWebpackError';
-        Error.captureStackTrace(this, PublistWebpackError);
+class PublistWebpackError extends WError {
+    constructor(cause, info) {
+        super({
+            name: 'PublistWebpackError',
+            cause,
+            info,
+            constructorOpt: PublistWebpackError,
+        }, `Aborting because there were errors when webpacking`);
     }
 }
 module.exports.PublistWebpackError = PublistWebpackError;