适用于 Windows 的 NPM 包'bin'脚本

Question

Cucumber.js提供了一个命令行"二进制"，这是一个包含shebang指令的简单.js文件：

#!/usr/bin/env node
var Cucumber = require('../lib/cucumber');
// ...

二进制文件在package.json中使用"bin"配置键指定：

{ "name" : "cucumber"
, "description" : "The official JavaScript implementation of Cucumber."
// ...
, "bin": { "cucumber.js": "./bin/cucumber.js" }
// ...

这一切都在POSIX系统上运行良好。有人报告在Windows上运行Cucumber.js时出现问题。

基本上，.js文件似乎是通过Windows的JScript解释器(而不是Node.js(执行的，并且由于shebang指令而抛出语法错误。

我的问题是：设置适用于UNIX和Windows系统的"二进制"脚本的推荐方法是什么？

谢谢。

Answer 1

Windows 忽略 shebang 行#!/usr/bin/env node，并根据.js文件关联执行它。明确使用 node 调用脚本

node hello.js

Pedantry：shebangs不在POSIX标准中，但它们被大多数*nix系统支持。

---

如果将项目打包为 Npm，请使用 package.json 中的"bin"字段。然后在Windows上，Npm将在脚本旁边安装一个.cmd包装器，以便用户可以从命令行执行它

hello

要使 npm 正确创建填充程序，脚本必须具有 shebang 行#!/usr/bin/env node

Answer 2

你的"bin"应该是"cucumber" npm 将创建一个指向"node %SCRIPTNAME%"的"cucumber"或"cucumber.cmd"文件。 前者用于POSIX环境，后者用于Windows使用... 如果您希望"js"成为可执行文件名称的一部分...你应该使用菌丝代替..."黄瓜-JS" ...在您的情况下，.js文件将出现在 .js.cmd 之前，导致 WScript 解释器将其作为 JScript 文件而不是节点脚本运行。

我建议看看coffee-script的package.json作为一个很好的例子。

{
  "name":         "coffee-script",
  "description":  "Unfancy JavaScript",
  "keywords":     ["javascript", "language", "coffeescript", "compiler"],
  "author":       "Jeremy Ashkenas",
  "version":      "1.4.0",
  "licenses":     [{
    "type":       "MIT",
    "url":        "https://raw.github.com/jashkenas/coffee-script/master/LICENSE"
  }],
  "engines":      {
    "node":       ">=0.4.0"
  },
  "directories" : {
    "lib" : "./lib/coffee-script"
  },
  "main" : "./lib/coffee-script/coffee-script",
  "bin":          {
    "coffee":     "./bin/coffee",
    "cake":       "./bin/cake"
  },
  "scripts": {
    "test": "node ./bin/cake test"
  },
  "homepage":     "http://coffeescript.org",
  "bugs":         "https://github.com/jashkenas/coffee-script/issues",
  "repository":   {
    "type": "git",
    "url": "git://github.com/jashkenas/coffee-script.git"
  },
  "devDependencies": {
    "uglify-js":  ">=1.0.0",
    "jison":      ">=0.2.0"
  }
}

Answer 3

我设法找到了类似问题的解决方案。

我最初的计划是只有一个大的.js文件，用于 API 和 CLI(原因是因为当时我不知道如何在两个文件之间共享变量(。当一切都建成后，我试图将#!/usr/bin/env node shebang 添加到我的文件中。但是，这并没有阻止Windows Script Host给出错误。

我最终做的是想出一个"变量桥"的想法，它允许使用 getVar 和 setVar 读取和设置变量。这使我不得不从 API 代码中提取 CLI 代码，并向变量桥添加一些导入。

在 CLI 文件中，我添加了 shebang，并将项目的package.json修改为：

{
    ...
    "main": "./bin/api.js",
    "bin": {
        "validator": "./bin/cli.js"
    }
    ...
}

以下是一些小注释，我认为如果

Windows脚本主机仍然给出错误，可能会有所帮助(我应用了所有这些注释，所以我不确定哪一个有所帮助(：

• 仅使用 LF 行尾似乎有所帮助。

• 似乎./bin是编译文件的首选目录。我确实尝试了./dist但它对我不起作用。

• 可能需要在 shebang 之后留一个空行：

  // cli.js
  #!/usr/bin/env node
  // code...
  

在

• package.json中对main和bin使用相同的名称对我来说似乎是一个问题。