如何在Jest中自定义异常格式化，实现Error子类的美化打印？

1. 完善自定义Error类的toString方法（优先方案） #

如果可以修改自定义Error的代码，直接添加toString方法并修复原型链（继承Error的必要步骤，避免原型方法失效）：

class SomeCustomError extends Error {
    constructor(custom, stuff, message) {
        super(message);
        this._custom = custom;
        this._stuff = stuff;
        // 修复原型链，确保instanceof判断和原型方法正常工作
        Object.setPrototypeOf(this, SomeCustomError.prototype);
    }

    toString() {
        // 自定义格式化内容，按需调整格式
        return `[SomeCustomError] 自定义字段: ${this._custom}, 附加内容: ${this._stuff}, 错误消息: ${this.message}`;
    }
}

如果无法修改原Error类（比如来自第三方库），可以在Jest全局初始化文件中动态扩展原型：

// jest.setup.js（需在jest.config.js中配置加载）
SomeCustomError.prototype.toString = function() {
    return `[SomeCustomError] 自定义字段: ${this._custom}, 附加内容: ${this._stuff}, 错误消息: ${this.message}`;
};

2. 配置Jest全局加载初始化文件 #

在jest.config.js中添加setupFilesAfterEnv配置，让Jest在所有测试执行前加载我们的初始化文件：

module.exports = {
    // 其他原有配置...
    setupFilesAfterEnv: ['./jest.setup.js'],
};

3. 让Jest使用自定义格式化结果输出错误 #

Jest默认会打印错误栈信息，我们可以通过两种方式让它优先使用自定义的toString结果：

方式A：自定义Jest内置错误格式化器 #

在jest.setup.js中覆盖Jest原生的错误格式化逻辑：

// 获取Jest原有的错误格式化器
const originalFormatError = require('jest-config').getConfig().formatError;

// 替换为自定义格式化逻辑
jest.setConfig({
    formatError: (error) => {
        // 仅处理目标自定义Error子类
        if (error instanceof SomeCustomError) {
            return error.toString();
        }
        // 其他错误沿用原格式化方式
        return originalFormatError(error);
    }
});

方式B：全局捕获未处理异常并自定义输出 #

如果方式A不生效，可通过Node.js全局事件捕获测试中的未处理异常，自定义输出后重新抛出以确保Jest标记测试失败：

// jest.setup.js
// 处理未处理的Promise拒绝
process.on('unhandledRejection', (reason) => {
    if (reason instanceof SomeCustomError) {
        console.error('\n' + reason.toString() + '\n');
    }
    // 重新抛出，保证Jest识别测试失败
    throw reason;
});

// 处理未捕获的同步异常
process.on('uncaughtException', (error) => {
    if (error instanceof SomeCustomError) {
        console.error('\n' + error.toString() + '\n');
    }
    throw error;
});

验证效果 #

当测试中抛出SomeCustomError时，Jest会打印我们自定义的格式化内容，而非仅显示基类Error的message属性，且该配置对所有测试全局生效，无需逐个装饰测试用例。

内容的提问来源于stack exchange，提问作者Croad Langshan