将命令行参数发送到npm脚本

Question

scripts我package.json目前的部分看起来像这样:

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

...这意味着我可以运行npm start来启动服务器.到现在为止还挺好.

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

Answer 1

编辑2014.10.30: 可以将args传递给npm runnpm 2.0.0

语法如下:

npm run <command> [-- <args>]

请注意必要的--.需要将传递给npm命令本身的params和传递给脚本的params分开.

所以,如果你有 package.json

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

然后以下命令是等效的:

grunt task:target => npm run grunt -- task:target

node server.js --port=1337 => npm run server -- --port=1337

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

编辑2013.10.03:目前无法直接进行.但是有一个相关的GitHub问题已经开启,npm以实现您所要求的行为.似乎共识是实现这一点,但这取决于之前解决的另一个问题.

原始答案:作为某种解决方法(虽然不是很方便),您可以执行以下操作:

说你的包名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

然后,在调用时npm start,将使用9090(默认来自package.json被覆盖).

Answer 2

你问到能够运行什么样 npm start 8080.这可以在不需要script.js如下修改或配置文件的情况下实现.

例如,在您的"scripts"JSON值中,include--

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

然后从命令行:

$ PORT=8080 npm start

我已经确认这可以使用bash和npm 1.4.23.请注意,这种解决方法不需要解决GitHub npm 问题#3494.

Answer 3

你也可以这样做:

在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 4

jakub.g的回答是正确的,但是使用grunt的例子看起来有点复杂.

所以我的答案更简单:

- 将命令行参数发送到npm脚本

将命令行参数发送到npm脚本的语法:

npm run [command] [-- <args>]

想象一下,我们的package.json中有一个npm启动任务,以启动webpack dev服务器:

"scripts": {
  "start": "webpack-dev-server --port 5000"
},

我们从命令行运行它 npm start

现在,如果我们想要将端口传递给npm脚本:

"scripts": {
  "start": "webpack-dev-server --port process.env.port || 8080"
},

运行这个并通过命令行传递端口例如5000将如下:

npm start --port:5000

- 使用package.json配置:

正如jakub.g所提到的,您也可以在package.json的配置中设置params

"config": {
  "myPort": "5000"
}

"scripts": {
  "start": "webpack-dev-server --port process.env.npm_package_config_myPort || 8080"
},

npm start 将使用您的配置中指定的端口,或者您可以覆盖它

npm config set myPackage:myPort 3000

- 在你的npm脚本中设置一个参数

读取npm脚本中的变量集的示例.在这个例子中NODE_ENV

"scripts": {
  "start:prod": "NODE_ENV=prod node server.js",
  "start:dev": "NODE_ENV=dev node server.js"
},

在阅读NODE_ENV server.js无论是督促或开发

var env = process.env.NODE_ENV || 'prod'

if(env === 'dev'){
    var app = require("./serverDev.js");
} else {
    var app = require("./serverProd.js");
}

Answer 5

我过去一直在使用这种单线，在离开 Node.js 一段时间后，最近不得不尝试重新发现它。与@francoisrv 提到的解决方案类似，它利用了node_config_*变量。

创建以下最小package.json文件：

{
  "name": "argument",
  "version": "1.0.0",
  "scripts": {
    "argument": "echo \"The value of --foo is '${npm_config_foo}'\""
  }
}

运行以下命令：

npm run argument --foo=bar

观察以下输出：

--foo 的值是 'bar'

所有这些都很好地记录在 npm 官方文档中：

• https://docs.npmjs.com/using-npm/config

注：在环境变量标题解释说，里面的脚本变量也表现不同，以什么文档中定义。当涉及到区分大小写以及参数是用空格还是等号定义时，情况确实如此。

注意：如果您使用带连字符的参数，这些将在相应的环境变量中替换为下划线。例如，npm run example --foo-bar=baz将对应于${npm_config_foo_bar}。

注意：对于非 WSL Windows 用户，请参阅下面@Doctor Blue 的评论... TL;DR 替换${npm_config_foo}为%npm_config_foo%.

Answer 6

process.argv在代码中使用然后只提供$*脚本值条目的尾随.

作为一个例子,尝试使用一个简单的脚本,它只是将提供的参数记录到标准输出echoargs.js:

console.log('arguments: ' + process.argv.slice(2));

的package.json:

"scripts": {
    "start": "node echoargs.js $*"
}

例子:

> npm start 1 2 3
arguments: 1,2,3

process.argv[0]是可执行文件(node),process.argv[1]是你的脚本.

使用npm v5.3.0和node v8.4.0进行测试

Answer 7

对于 Windows 上的 PowerShell 用户

接受的答案对我来说不适用于 npm 6.14。添加 no--或包含一次都不起作用。然而，在参数之前放置--两次或一次就可以了。"--"例子：

npm run <my_script> -- -- <my arguments like --this>

怀疑原因

就像在 bash 中一样，--指示 PowerShell 将所有以下参数视为文字字符串，而不是选项（例如，请参阅此答案）。问题似乎是该命令的解释次数比预期多一倍，从而丢失了'--'. 例如，通过做

npm run <my_script> -- --option value

npm 将运行

<my_script> value

然而，做

<my_script> value

结果是

npm run <my_script> "--" --option value

效果很好。

Answer 8

npm 2.x支持 cli args

命令

npm run-script start -- --foo=3

的package.json

"start": "node ./index.js"

Index.js

console.log('process.argv', process.argv);

Answer 9

如果你想将参数传递给npm脚本的中间,而不是将它们附加到末尾,那么内联环境变量似乎很好地工作:

"scripts": {
  "dev": "BABEL_ARGS=-w npm run build && cd lib/server && nodemon index.js",
  "start": "npm run build && node lib/server/index.js",
  "build": "mkdir -p lib && babel $BABEL_ARGS -s inline --stage 0 src -d lib",
},

在这里,npm run dev将-wwatch标志传递给babel,但npm run start只运行一次常规构建.

Answer 10

上面的大多数答案只是将参数传递到由 npm 调用的 NodeJS 脚本中。我的解决方案是通用的。

只需使用 shell 解释器（例如sh）调用包装 npm 脚本并像往常一样传递参数。唯一的例外是第一个参数编号是0。

例如，您想添加 npm script someprogram --env=<argument_1>，其中someprogram只打印env参数的值：

包.json

"scripts": {
  "command": "sh -c 'someprogram --env=$0'"
}

当你运行它时：

"scripts": {
  "command": "sh -c 'someprogram --env=$0'"
}

Answer 11

--使用脚本将参数分开并添加所有必需的参数，我们稍后可以通过索引访问它们。

npm run start -- myemail@gmail.com 100

您可以使用以下方式获取节点中的参数

const params = process.argv.slice(2);
console.log(params);

输出

['myemail@gmail.com', '100']

Answer 12

这并不能真正回答您的问题,但您可以始终使用环境变量:

"scripts": {
    "start": "PORT=3000 node server.js"
}

然后在您的server.js文件中:

var port = process.env.PORT || 3000;