向npm脚本发送命令行参数

Question

我的package.json的scripts部分当前如下所示：

"scripts": {
    "start": "node ./script.js server"
}

...这意味着我可以运行npm start来启动服务器。到目前为止还不错。

但是，我希望能够运行类似npm start 8080的东西，并将参数传递给script.js（例如，npm start 8080=>node./script.js server 8080)。这可能吗？

Answer 1

您也可以这样做：

在package.json中：

"scripts": {
    "cool": "./cool.js"
}

在cool.js中：

 console.log({ myVar: process.env.npm_config_myVar });

在CLI中：

npm --myVar=something run-script cool

应输出：

{ myVar: 'something' }

更新：使用npm 3.10.3，它似乎将process.env.npm_config_变量小写？我还在使用better-npm-run，所以我不确定这是否是普通的默认行为，但这个答案是有效的。请尝试process.env.npm_config_myvar而不是process.env.npm_config_myvar

Answer 2

您要求能够运行类似npm start8080的内容。这是可能的，不需要修改script.js或配置文件，如下所示。

例如，在“scripts”JSON值中，包括--

"start": "node ./script.js server $PORT"

然后从命令行：

$ PORT=8080 npm start

我已经确认使用bash和npm1.4.23可以工作。请注意，此解决方法不需要解决GitHub npm问题#3494。

Answer 3

自npm 2（2014年）以来，可以将参数传递给npm Run。语法如下：

NPM运行[-- ]

请注意--分隔符，用于分隔传递给npm命令本身的参数和传递给脚本的参数。

示例package.json:

  "scripts": {
    "grunt": "grunt",
    "server": "node server.js"
  }

以下是如何将参数传递给这些脚本：

npm run grunt -- task:target  // invokes `grunt task:target`
npm run server -- --port=1337 // invokes `node server.js --port=1337`

注意：如果您的参数不以-或--开头，则不需要显式的--分隔符；但为了清晰起见，最好还是这样做。

npm run grunt task:target     // invokes `grunt task:target`

注意下面的行为差异(test.js有console.log(process.argv)):以-或--开头的参数传递给npm而不是脚本，并且在那里被静默吞噬。

$ npm run test foobar
['C:\\Program Files\\nodejs\\node.exe', 'C:\\git\\myrepo\\test.js',  'foobar']

$ npm run test -foobar
['C:\\Program Files\\nodejs\\node.exe', 'C:\\git\\myrepo\\test.js']

$ npm run test --foobar
['C:\\Program Files\\nodejs\\node.exe', 'C:\\git\\myrepo\\test.js']

$ npm run test -- foobar
['C:\\Program Files\\nodejs\\node.exe', 'C:\\git\\myrepo\\test.js', 'foobar']

$ npm run test -- -foobar
['C:\\Program Files\\nodejs\\node.exe', 'C:\\git\\myrepo\\test.js', '-foobar']

$ npm run test -- --foobar
['C:\\Program Files\\nodejs\\node.exe', 'C:\\git\\myrepo\\test.js', '--foobar']

当您使用NPM实际使用的参数时，差别就更清楚了：

$ npm test --help      // this is disguised `npm --help test`
npm test [-- <args>]

aliases: tst, t

若要获得参数值，请参阅以下问题。对于读取命名参数,最好使用yargs或Minimist这样的解析库；nodejs全局公开process.argv，包含命令行参数值，但这是一个低级API（由操作系统提供给节点可执行文件的以空格分隔的字符串数组）。

编辑2013.10.03:当前无法直接编辑。但是在 npm上打开了一个相关的GitHub问题，以实现您所要求的行为。似乎大家一致认为应该实现这一目标，但这取决于之前解决的另一个问题。

原答案（2013.01）：作为某种变通办法（虽然不是很得心应手），你可以做如下：

在package.json中假设您的包名为mypackage并且您还

"scripts": {
    "start": "node ./script.js server"
}

然后添加package.json:

"config": {
    "myPort": "8080"
}

在script.js中：

// defaulting to 8080 in case if script invoked not via "npm run-script" but directly
var port = process.env.npm_package_config_myPort || 8080

这样，默认情况下npm start将使用8080。但是，您可以对其进行配置（该值将由npm存储在其内部存储器中）：

npm config set myPackage:myPort 9090

然后，当调用npmstart时，将使用9090（覆盖package.json中的默认值）。