Jest对比长字符串时如何扩展diff上下文显示行数？

Jest的diff上下文显示规则随版本不同有区别：

• Jest 27及更早版本：差异点前后各显示5行的规则是硬编码实现的，没有官方配置入口可以修改
• Jest 28及以上版本：上下文行数支持自定义配置，默认值保持为差异前后各5行

自定义上下文行数的配置方法 #

• 全局生效：在项目的Jest配置文件（jest.config.js/jest.config.ts）中添加diff字段，按需设置上下文行数即可：

module.exports = {
  // 项目原有其他配置保持不变
  diff: {
    contextLines: 20 // 示例值，代表差异位置前后各展示20行内容，可根据实际长字符串的长度调整
  }
}

• 单测试文件临时生效：在测试文件顶部调用配置API，仅对当前文件内的测试用例生效：

import { setDiffOptions } from 'jest-diff'

setDiffOptions({
  contextLines: 20
})

格式化JSON对比场景的优化方案 #

如果要对比的长字符串是格式化输出的JSON，完全不需要调整diff上下文参数，直接将字符串解析为原生JS对象后再做相等断言，定位差异的效率远高于逐行对比字符串：

describe('格式化JSON输出校验', () => {
  it('结构化对比直接定位字段差异', () => {
    const output1 = '{\n  "id": 1,\n  // 中间几十上百行格式化JSON内容\n  "status": "success"\n}'
    const output2 = '{\n  "id": 1,\n  // 中间几十上百行格式化JSON内容\n  "status": "failed"\n}'
    // 不推荐直接对比字符串，差异定位效率低
    // expect(output1).toEqual(output2)
    // 转成对象对比，*Jest会直接输出具体差异字段，不受换行、缩进格式干扰*
    expect(JSON.parse(output1)).toEqual(JSON.parse(output2))
  })
})

如果暂时无法升级Jest到28以上版本，也可以自定义Jest匹配器，将两个长字符串按换行符拆分为数组后逐行对比，自行控制差异输出的上下文范围。

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