Node.js 18+中prepareStackTrace返回值被方括号包裹的问题咨询

问题现象 #

在Node.js 18及以上版本中，自定义Error.prepareStackTrace返回字符串时，打印错误对象会发现返回值被方括号包裹；同时自定义返回内容时，默认的错误名称和消息会丢失，需要手动添加。例如：

Error.prepareStackTrace = (err, stack) => {
  return 'foo'
}

const err = new Error('test')
console.log(err)

执行后输出：

[foo]

解决方案 #

方案1：返回包含错误头部的堆栈数组 #

Node.js对数组类型的返回值会按默认格式打印，不会添加方括号，可手动拼接错误名称、消息和堆栈行：

Error.prepareStackTrace = (err, stack) => {
  // 拼接错误名称与消息作为头部
  const errorHeader = `${err.name}: ${err.message}`;
  // 将堆栈帧转为标准格式字符串
  const stackLines = stack.map(frame => `    at ${frame.toString()}`);
  // 返回包含头部和堆栈的数组
  return [errorHeader, ...stackLines];
};

// 测试
const err = new Error('自定义错误消息');
console.log(err);

输出示例：

Error: 自定义错误消息
    at Object.<anonymous> (/path/to/file.js:12:13)
    at Module._compile (node:internal/modules/cjs/loader:1256:14)
    ...

方案2：自定义错误对象的inspect方法 #

通过覆盖Node.js的自定义inspect符号，直接控制错误对象的打印内容：

Error.prepareStackTrace = (err, stack) => {
  // 生成完整的自定义错误字符串
  const fullErrorStr = `${err.name}: ${err.message}\n` +
    stack.map(frame => `    at ${frame.toString()}`).join('\n');
  // 将自定义内容挂载到错误对象上
  err._customStr = fullErrorStr;
  // 返回原堆栈帧数组，避免影响其他依赖堆栈的逻辑
  return stack;
};

// 覆盖默认的inspect行为
Error.prototype[Symbol.for('nodejs.util.inspect.custom')] = function() {
  return this._customStr;
};

// 测试
const err = new Error('自定义错误消息');
console.log(err);

此方案完全自定义打印内容，不会出现方括号包裹问题。

设计原因 #

Node.js 18+调整了Error.prepareStackTrace的处理逻辑：当返回值不是标准的堆栈帧数组时，会将其标记为用户自定义的非标准堆栈内容，用方括号包裹以区分默认堆栈格式，避免混淆。这种设计是为了对齐V8引擎的堆栈处理规范，同时明确标识自定义堆栈与默认堆栈的差异。

注意事项 #

自定义prepareStackTrace返回内容时，默认的错误名称和消息不会自动包含，必须手动通过err.name和err.message拼接进返回结果，否则会丢失这部分信息。

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