npm glob 模式与子目录不匹配

Posted 2023-03-07

【中文标题】npm glob 模式与子目录不匹配

【英文标题】：npm glob pattern not matching subdirectories

【发布时间】：2015-11-08 03:06:10

【问题描述】：

在我的package.json 中，我有一个使用**/*Test.js 匹配文件的脚本块。通过npm 运行时，它们与子目录的匹配不超过一级。当直接在命令行上执行时，它们会按预期工作。

谁能解释发生了什么，并提供解决方法或解决方案？

package.json

  "name": "immutable-ts",
  "scripts": 
    "test": "echo mocha dist/**/*Test.js",
  

执行

% npm run test

> immutable-ts@0.0.0 test:unit .../immutable-ts
> echo mocha dist/**/*Test.js

mocha dist/queue/QueueTest.js dist/stack/StackTest.js

% echo mocha dist/**/*Test.js

mocha dist/queue/QueueTest.js dist/stack/StackTest.js dist/tree/binary/BinaryTreeTest.js

% ls dist/**/*                                                                                                                                                                                          

dist/collections.js  dist/queue/QueueTest.js  dist/tree/binary/BinaryTree.js      dist/immutable.js.map        dist/stack/Stack.js.map             dist/tree/binary/BinaryTreeTest.js.map
dist/immutable.js    dist/stack/Stack.js      dist/tree/binary/BinaryTreeTest.js  dist/queue/Queue.js.map      dist/stack/StackTest.js.map
dist/queue/Queue.js  dist/stack/StackTest.js  dist/collections.js.map             dist/queue/QueueTest.js.map  dist/tree/binary/BinaryTree.js.map

【参考方案1】：

glob 扩展实际上是由您的 shell 完成的，这就是它从命令行工作的原因。

您可以使用mocha --recursive 并指向您的测试目录。

【讨论】：

NPM 正在使用 shell 执行script 命令。 shell执行环境有什么区别？不，我不能使用-recursive，因为我没有测试文件夹。正如ls 清单所示，测试与它们的实现相邻。

【参考方案2】：

您可以在脚本中将find 命令与-name 选项内联，以替换zsh 提供的扩展通配符语法。

在你的情况下，命令是：

mocha `find dist -type f -name '*Test.js'`

如果您确信永远不会将“Test.js”放在目录名称中，则实际上可以省略 -type f 部分。 （很可能是一个安全的假设，但为了完整起见，我将其包括在内）

【参考方案3】：

解决方案

更改您的脚本，以便您传递给 Mocha 的内容不会被 shell 扩展：

"scripts": 
    "test": "mocha 'dist/**/*Test.js'",
 

注意mocha 的参数周围的单引号。

说明

无需借助外部工具即可解决此问题。问题的根本原因是 npm 使用 sh 作为运行脚本命令的 shell。

绝大多数情况下，当 *nix 进程启动 shell 时，它将启动 sh，除非有什么告诉它不这样做。您为登录设置的 shell 首选项并不构成“以其他方式告诉它”的方式。因此，如果您使用 zsh 作为登录 shell，则并不意味着 npm 将使用 zsh。

那些sh 的实现不包含任何超出sh 应提供的扩展，但不会以您希望的方式理解** glob。据我所知，它被解释为*。然而，Mocha 使用其 glob 的 javascript 实现来解释传递给它的路径。因此，您可以通过保护您的 glob 不被sh 解释来解决此问题。请考虑以下package.json：

  "name": "immutable-ts",
  "scripts": 
    "bad": "mocha test/**/*a.js",
    "good": "mocha 'test/**/*a.js'",
    "shell": "echo $0"
  

shell 脚本只是为了让我们可以检查哪个 shell 正在运行该脚本。如果你运行它，你应该会看到sh。

现在，给定以下树：

test/
├── a.js
├── b.js
├── x
│   ├── a
│   │   ├── a.js
│   │   └── b.js
│   ├── a.js
│   └── b
│       └── a.js
└── y
    ├── a.js
    └── q

所有a.js 和b.js 文件都包含it(__filename);。您会得到以下结果：

$ npm run bad

> immutable-ts@ bad /tmp/t2
> mocha test/**/*a.js

  - /tmp/t2/test/x/a.js
  - /tmp/t2/test/y/a.js

  0 passing (6ms)
  2 pending

$ npm run good

> immutable-ts@ good /tmp/t2
> mocha 'test/**/*a.js'

  - /tmp/t2/test/a.js
  - /tmp/t2/test/x/a.js
  - /tmp/t2/test/x/a/a.js
  - /tmp/t2/test/x/b/a.js
  - /tmp/t2/test/y/a.js

  0 passing (5ms)
  5 pending

【讨论】：

这适用于 mocha，但并非我想使用的每个工具都有自己的（更不一样的）全局扩展。