Node.js自定义测试框架如何兼容import/require导入测试文件

嗨，我来帮你搞定这个模块导入的兼容问题——我之前开发自定义测试框架时也踩过几乎一样的坑，给你几个实用的解决方案：

方案1：用动态import()统一加载测试文件 #

不管你的测试文件是用ES模块的import还是CommonJS的require，动态import()都是通用的异步加载方式，Node.js 12+就支持，你的13.14版本完全没问题。把原来同步的require(file)换成异步的import()，再用async/await处理就行：

// 改写你的测试文件加载逻辑
async function loadTestFile(filePath) {
  try {
    // 动态导入不管是ES还是CommonJS模块都能处理
    const testModule = await import(filePath);
    // 这里可以处理测试模块里的test函数等内容
    return testModule;
  } catch (err) {
    console.error('加载测试文件失败:', err);
    throw err;
  }
}

如果你的测试文件是ES模块，要么把后缀改成.mjs，要么在package.json里设"type": "module"，动态import()都能正常加载。要是你在CommonJS环境里用，也不需要改package.json，直接用就行。

方案2：用esm模块做桥接（适合低版本Node.js） #

如果你还需要兼容Node.js 11.15这种旧版本，第三方模块esm可以帮你在CommonJS环境里直接加载ES模块，不用改文件后缀或者package.json。

首先安装它：

npm install esm

然后有两种使用方式：

• 启动时注入：node -r esm your-test-framework.js
• 在代码里先初始化：

// 代码顶部先加载esm，改写require函数
require = require('esm')(module);
// 之后就能用require加载用import写的测试文件了
const testModule = require('./your-test-file.js');

这样不管测试文件是ES还是CommonJS格式，都能正常加载，完美兼容低版本Node。

方案3：在测试文件里做兼容判断（适合测试文件可控的场景） #

如果你的测试文件都是自己写的，也可以在测试文件开头加一段条件判断，同时支持两种导入方式：

// 测试文件开头处理模块导入
let somemethod;
if (typeof require !== 'undefined') {
  // CommonJS环境下用require
  somemethod = require('./some/module').somemethod;
} else {
  // ES模块环境下用import
  import { somemethod } from './some/module';
}

// 后面的测试逻辑保持不变
test(/I click on a button/, () => {
  browser.get("someSelector").should("have.text", somemethod());
});

不过这种方式有点繁琐，要是模块依赖多的话维护起来麻烦，更适合简单的测试场景。

额外小技巧：ES模块环境里用require #

如果你切换到Node.js 13.14并设置了"type": "module"，想继续用require加载CommonJS模块，可以用createRequire：

import { createRequire } from 'module';
const require = createRequire(import.meta.url);
// 现在就能用require加载CommonJS模块了
const someCjsPackage = require('some-cjs-package');

这个方法能解决你开启type:module后不能用require的问题。

最后建议尽量升级到Node.js LTS版本（比如16+），对ES模块的支持更完善，兼容性问题会少很多。

内容的提问来源于stack exchange，提问作者Amit Kumar Gupta