Mocha: 在监视模式下支持 ESM

先决条件

• [x] 通过使用faq标签交叉引用
• [x] 在没有 Mocha 的情况下使用相同的环境和/或转译器配置检查下一代 ES 问题和语法问题，以确保它不仅仅是相关环境中实际上不支持的功能或代码中的错误.
• [x] 通过在真实测试套件之外运行要测试的代码来“冒烟测试”，以更好地了解问题是出在被测代码、您对 Mocha 的使用还是出在 Mocha 本身中
• [x] 确保本地和全球安装的 Mocha 版本之间没有差异。 您可以通过以下方式找到它们： node node_modules/.bin/mocha --version （本地）和mocha --version （全球）。 我们建议您_不要_全局安装 Mocha。

描述

当运行--watch具有封装内"type": "module"在其设置package.json ，摩卡未能正确import ，而不是尝试require()的文件。

$ npm run test-mocha:watch

> @ test-mocha:watch /home/jdalrymple/src/bugs/mochajs
> mocha --require @babel/register $(find ./src -type f -name '*.test.js') --watch

internal/modules/cjs/loader.js:1217
      throw new ERR_REQUIRE_ESM(filename, parentPath, packageJsonPath);
      ^

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /.../src/index.test.js
require() of ES modules is not supported.
require() of /.../src/index.test.js from /.../node_modules/mocha/lib/mocha.js is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename index.test.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /.../package.json.

    at Module._extensions..js (internal/modules/cjs/loader.js:1217:13)
    at Object.newLoader [as .js] (/home/jdalrymple/src/bugs/mochajs/node_modules/pirates/lib/index.js:104:7)
    at Module.load (internal/modules/cjs/loader.js:1050:32)
    at Function.Module._load (internal/modules/cjs/loader.js:938:14)
    at Module.require (internal/modules/cjs/loader.js:1090:19)
    at require (internal/modules/cjs/helpers.js:75:18)
    at /home/jdalrymple/src/bugs/mochajs/node_modules/mocha/lib/mocha.js:384:36
    at Array.forEach (<anonymous>)
    at Mocha.loadFiles (/home/jdalrymple/src/bugs/mochajs/node_modules/mocha/lib/mocha.js:381:14)
    at Mocha.run (/home/jdalrymple/src/bugs/mochajs/node_modules/mocha/lib/mocha.js:954:10)
    at Object.run (/home/jdalrymple/src/bugs/mochajs/node_modules/mocha/lib/cli/watch-run.js:223:20)
    at FSWatcher.<anonymous> (/home/jdalrymple/src/bugs/mochajs/node_modules/mocha/lib/cli/watch-run.js:169:14)
    at FSWatcher.emit (events.js:314:20)
    at /home/jdalrymple/src/bugs/mochajs/node_modules/mocha/node_modules/chokidar/index.js:364:35
    at processTicksAndRejections (internal/process/task_queues.js:75:11) {
  code: 'ERR_REQUIRE_ESM'
}
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! @ test-mocha:watch: `mocha --require @babel/register $(find ./src -type f -name '*.test.js') --watch`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the @ test-mocha:watch script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/jdalrymple/.npm/_logs/2020-07-14T00_20_36_063Z-debug.log

重现步骤

为方便起见，创建了以下存储库以充分重现该问​​题：

1. 确保您的节点版本与下面列出的版本匹配
2. 克隆 repo： https :
3. 安装它的依赖： npm i
4. 测试回购： npm run test-mocha
5. 开始观看： npm run test-mocha:watch

预期行为：

• 摩卡将开始观看文件

实际行为：

• 尝试观看文件时抛出错误

版本

包版本

• 节点：v14.5.0
• 摩卡咖啡：8.0.1
• 巴贝尔：v7.10.4

环境

• 操作系统：Linux、Arch、x86_64
• 外壳：tmux + zsh

附加信息

我的理解是以下场景是适用的：

import应在以下条件下使用：

• 如果目标文件关联的package.json文件包含"type": "module"并且其文件扩展名为.js
• 如果目标文件的扩展名是.mjs ，则不管其关联的package.json文件中的内容

require()应在以下条件下使用：

• 如果目标文件关联的package.json文件不包含"type": "module"且其文件扩展名为.js
• 如果目标文件的扩展名是.cjs ，则不管其关联的package.json文件中的内容

结论

目前，似乎--watch假设目标文件是 CommonJS 模块，而其扩展名是.js ，并且未能屈服于其package.json文件的"type": "module" .

注意事项

值得考虑的事实是，与正在导入的文件关联的package.json文件可能与调用 mocha 的目录中的package.json不同，即使目标文件的路径确实如此不包括node_modules 。