Testcafe v1.17.0无法在.testcaferc.js配置文件中导入外部文件及依赖

问题根因 #

Testcafe v1.x版本默认使用CommonJS规范加载.testcaferc.js配置文件，你使用的ES Module import语法不被支持，因此触发配置文件读取错误。

解决方案 #

方案1：改用CommonJS规范导入（推荐，适配性最高）

把配置文件中的导入语句替换为require写法：

const Shared = require("./shared"); // 自定义JS文件导入
const clonedeep = require('lodash.clonedeep'); // 第三方依赖导入

如果你的./shared文件是用export default导出的，需要追加.default取默认导出内容：

const Shared = require("./shared").default;

方案2：使用ES Module规范加载配置

如果你的项目整体使用ES Module（package.json中配置了"type": "module"），可以把配置文件重命名为.testcaferc.mjs，即可保留原有的import导入语法，Testcafe v1.17.0已支持该格式的配置文件。

配置文件示例 #

以下是完整的配置文件参考写法：

// .testcaferc.js
const path = require('path');
const Shared = require(path.resolve(__dirname, './shared'));
const clonedeep = require('lodash.clonedeep');

module.exports = {
  // 全局hooks配置
  hooks: {
    fixture: {
      before: async () => {
        // 原fixture before中的API请求逻辑迁移到此处
        const initData = clonedeep(Shared.baseConfig);
        await Shared.batchRequest(initData);
      }
    }
  },
  // 其余原有配置项
  browsers: ['chrome'],
  src: ['./tests/**/*.test.js']
}

异常排查 #

如果修改后仍提示配置文件读取错误，可按以下顺序排查：

• 检查导入路径是否正确，相对路径是相对于执行Testcafe命令的工作目录，建议用path.resolve(__dirname, 'xxx')拼接绝对路径避免路径错误
• 检查依赖包是否已正确安装，执行npm i lodash.clonedeep确认第三方依赖存在
• 确认自定义的shared.js文件无语法错误，可单独执行该文件验证可用性

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