【问题标题】:Configure node npm package.json so that "npm test" works on both unix and windows配置节点 npm package.json 以便“npm test”在 unix 和 windows 上都可以工作
【发布时间】:2026-02-01 10:45:02
【问题描述】:

我开发了一个 node.js npm 模块,在 Windows 下开发。今天我写了一些摩卡测试。经过多次挣扎,npm test 似乎要工作,package.json 必须是这样的:(可能还有其他选择???)

"scripts": { "test": "node node_modules/mocha/bin/mocha" }

而不是所有基于 Unix 的书籍中的内容,

"scripts": { "test": "./node_modules/.bin/mocha" }

如何设置 package.json 以在 Windows 和 Unix 上工作?我假设 Travis-CI 运行 Unix,所以,如果我将构建链接到它,它将与 Windows 版本一起爆炸。

我发现了一个两年前的帖子,有人要求为此提供功能。那根线似乎死了。这个SO question 似乎很接近,但这并不是我想要的,坦率地说,我无法理解答案。 :-( 有人可以澄清一下吗?

我先走了

"scripts": {
      "test": "node node_modules/mocha/bin/mocha",
      "testOnUnixUseThis"    : "./node_modules/.bin/mocha (I think)",
      "testOnWindowsUseThis" : "node node_modules/mocha/bin/mocha"
  },

很遗憾,你不能去npm test testOnWindowsUseThisnpm testOnWindowsUseThis。而且它不能解决 Travis-CI 问题。但至少下载模块的人可以(希望)看到发生了什么。

有更好的想法吗?我是唯一还在 Windows 下开发的人吗??? :-)

【问题讨论】:

    标签: windows node.js unix npm


    【解决方案1】:

    我一直都可以npm install -g mochanpm install mocha 然后添加

    "scripts": {
        "test": "mocha spec"
    }
    

    到 package.json。这可能会或可能不会在每个环境中都有效。例如,我知道,对于巡线员,您必须使用 bin/mocha。此外,如果您找不到解决此问题的方法,请将您的测试脚本设置为 Unix,然后添加第二个名为“wintest”的脚本,或者在 Windows 中执行您需要它执行的任何操作。您可以随意命名脚本。默认的(测试、启动等)可以和npm [command]一起使用;任何非标准的(如 wintest)都可以与npm run-script [command] 一起使用,它们仍然可以工作。

    关于它如何/为什么起作用的小背景故事:

    当您全局安装模块时,它可以在 PATH(或任何 Windows 等效项)上使用。当您安装项目依赖项时,如果该模块有任何二进制文件,它们将符号链接到 node_modules/.bin,当您运行 npm run [some-command] 时,npm 会为该命令将 node_modules/.bin 添加到 PATH 。因此,当全局安装 mocha 时,"test": "mocha spec" 使用全局安装的 mocha 来运行测试。当它是一个项目依赖时,它使用node_modules/.bin 中的那个。我发现的一个问题是 npm 将 node_modules/.bin 添加到 PATH 的 front 中,因此本地二进制文件将始终优先于全局二进制文件。 几乎所有时间,这就是你想要的,但值得知道它就是这样工作的(我最近遇到了一个与此相关的错误)。

    编辑:

    不确定在 npm 历史中的哪个时间点发生了这种变化,但 npm run <script-name> 现在可以工作了(不再需要 npm run-script <script-name> 了)。可能run-script 仍然有效。我希望它会,但我还没有尝试过。

    【讨论】:

    • +1 这适用于 Windows,比我见过或尝试过的其他替代方案简单得多。现在无法在 Unix 上进行测试,但我相信它可以工作。除非有人在接下来的几天内发布更好的答案,否则你会得到我的“支票”。
    • 刚刚将所有 Travis-ci 钩子连接在一起,效果很好。谢谢!
    • 实际上,"test": "mocha" 在 mac 和 linux 上对我有用。
    • 这取决于你命名你的测试目录。 Mocha 可能被配置为同时检查“test”和“spec”,但我认为明确表示仍然是一个好习惯。
    • 这会使你的包测试套件依赖于本地机器设置,包括全局安装的 mocha 版本,是的,它很可能会工作,但不确定这是推荐的做法。
    【解决方案2】:

    如何设置 package.json 在 Windows 和 Unix 上都可以工作?

    如果你

    • 使用 Windows
    • 不喜欢 -g 全局安装

    ...这是一个可行的解决方案

    "scripts": {
      "test": "node node_modules/mocha/bin/mocha.js"
    },
    

    注意事项

    • node 放在前面应该不会造成伤害,并且可以在 Windows 上有所帮助(.js 扩展名不一定注册到 nodejus 可执行文件,除非您设置它。可以打开文本编辑器、IDE 或(更糟) Windows 脚本主机、Internet Explorer……)
    • 直接处理脚本可以让您无需进行全局安装。 (不判断这是否是一个好习惯)
    • 正斜杠有助于在 linux 下运行(显然)并在 windows 下工作(在这种情况下。还避免了 windows 陷阱:如果使用反斜杠,则需要加倍 - 因为如果单独使用它们会被解释为转义以下字母)。

    【讨论】:

      【解决方案3】:

      不要使用全局解决方案,建议你关注摩卡大佬say

      "scripts": {  
          "test": "node_modules/.bin/mocha -w"
       },
      

      【讨论】:

        【解决方案4】:

        使用npm i mocha --save-dev

        这会将模块保存为开发依赖项,npm 将自动设置要在 scripts 对象中使用的可执行文件。如果您想使用 package.json 中定义的脚本之外的可执行文件,您也可以全局安装它,但请注意,您最终可能会使用不同版本的包。

        如果您只在全局范围内安装它,其他人在尝试运行您的测试时会不高兴(使用标准 npm test

        【讨论】:

          【解决方案5】:

          6.x之后最新npm版本的新方式,你再也不用global模式安装mocha了。

          "scripts": { "test": "npx mocha" }
          

          npx 会随着新的 npm 安装自动安装。它会搜索 mocha 来自 node_modules/.bin 或 $PATH

          参考:https://www.npmjs.com/package/npx

          【讨论】:

            最近更新 更多