如何用Jest编写可检测代码中是否含console.log的单元测试

以下提供两种常用实现方式，可根据你的需求选择： #

方案1：运行时调用检测 #

仅检测代码实际执行路径中是否触发console.log，实现成本最低，适合配合业务逻辑测试使用：

// 引入你要测试的业务模块
const yourModule = require('./your-module-path')

test('业务逻辑执行过程中无console.log调用', () => {
  // 劫持全局console.log方法，替换为空实现
  const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => {})

  // 执行你需要测试的业务代码逻辑
  yourModule.targetFunction()

  // 断言console.log未被调用，若有调用则测试失败
  expect(consoleLogSpy).not.toHaveBeenCalled()

  // 恢复console.log的原始实现，避免影响其他测试用例
  consoleLogSpy.mockRestore()
})

若需要同时检测console.warn、console.error等其他控制台方法，额外新增对应spy即可 #

方案2：静态源码扫描检测 #

只要源码文件中存在console.log语句（无论是否会被执行到）就判定失败，适合做全局代码规范校验：

const fs = require('fs')
const path = require('path')

test('所有源码文件不存在console.log语句', () => {
  // 配置需要扫描的源码目录
  const SCAN_DIR = path.resolve(__dirname, 'src')
  // 递归获取目录下所有js/ts/jsx/tsx文件
  const getAllSourceFiles = (dir) => {
    const entries = fs.readdirSync(dir, { withFileTypes: true })
    return entries.flatMap(entry => {
      const fullPath = path.join(dir, entry.name)
      return entry.isDirectory() ? getAllSourceFiles(fullPath) : fullPath
    }).filter(file => /\.(j|t)sx?$/.test(file))
  }
  // 遍历检测每个文件
  getAllSourceFiles(SCAN_DIR).forEach(filePath => {
    const fileContent = fs.readFileSync(filePath, 'utf8')
    // 正则匹配console.log语句，可自行调整规则排除注释场景
    const hasConsoleLog = /console\.log\s*\(/g.test(fileContent)
    expect(hasConsoleLog).toBe(false)
  })
})

如果需要排除注释中的console.log避免误判，可以改用Babel解析源码AST做精准匹配，比正则匹配准确率更高 #

全局生效配置技巧 #

如果需要所有测试用例都自动检测console.log调用，可以将spy逻辑写入Jest的setupFilesAfterEnv配置项中，无需每个测试单独编写。

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