将命令行参数发送到 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

npm 2 和更新版本

自 npm 2 (2014) 起，pass args to npm run 成为可能。语法如下：

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

注意-- 分隔符，用于分隔传递给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

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

---

编辑 2013.10.03： 目前无法直接进行。但是有一个相关的GitHub issue opened on npm 来实现您要求的行为。似乎共识是实现这一点，但这取决于之前解决的另一个问题。

---

原始答案（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

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

Answer 2

您要求能够运行 npm start 8080 之类的东西。无需修改script.js或配置文件即可，如下所示。

例如，在您的"scripts" JSON 值中，包含--

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

然后从命令行：

$ PORT=8080 npm start

我已经确认这可以使用 bash 和 npm 1.4.23。请注意，此解决方法不需要解析 GitHub npm issue #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，所以我不确定这是否是普通的默认行为，但这个答案is 有效。而不是process.env.npm_config_myVar，试试process.env.npm_config_myvar

Answer 4

jakub.g 的答案是正确的，但是使用 grunt 的示例似乎有点复杂。

所以我更简单的答案：

- 向 npm 脚本发送命令行参数

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

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

假设我们的 package.json 中有一个 npm start 任务来启动 webpack 开发服务器：

"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

的配置中设置参数

"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"
},

在 server.js 中读取 NODE_ENV，无论是 prod 还是 dev

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

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

Answer 5

从 npm 2.x 开始，您可以通过 -- 分隔 pass args into run-scripts

终端

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

Package.json

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

Index.js

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

Answer 6

我过去一直在使用这个单线，在离开 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

注意：Environment Variables 标题说明脚本中的变量的行为与文档中定义的不同。对于区分大小写，以及参数是用空格还是等号定义，情况都是如此。

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

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

Answer 7

在您的代码中使用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] 是可执行文件（节点），process.argv[1] 是您的脚本。

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

Answer 8

如果您想将参数传递到 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 将 -w 监视标志传递给 babel，但 npm run start 只运行一次常规构建。

Answer 9

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

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

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

package.json

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

当你运行它时：

% npm run -s command my-environment
my-environment

Answer 10

对于 Windows 上的 PowerShell 用户

接受的答案不适用于 npm 6.14。既不添加任何-- 也不包括它一次确实有效。但是，将-- 两次或将"--" 一次放在参数之前就可以了。示例：

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

怀疑原因

与 bash 中一样，-- 指示 PowerShell 将所有后续参数视为文字字符串，而不是选项 (E.g see this answer)。问题似乎是该命令的解释比预期的多一次，失去了'--'。例如，通过做

npm run <my_script> -- --option value

npm 将运行

<my_script> value

但是，做

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

结果

<my_script> "--option" "value"

效果很好。

Answer 11

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

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

然后在你的 server.js 文件中：

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

Answer 12

我在尝试解决运行 sequelize seed:generate cli 命令的问题时发现了这个问题：

node_modules/.bin/sequelize seed:generate --name=user

让我进入正题。我想在我的 package.json 文件中有一个简短的脚本命令并同时提供 --name 参数

经过一些实验后得到了答案。这是我在 package.json

中的命令

"scripts: {
  "seed:generate":"NODE_ENV=development node_modules/.bin/sequelize seed:generate"
}

...这是在终端中运行它以为 用户

生成种子文件的示例

> yarn seed:generate --name=user

> npm run seed:generate -- --name=user

仅供参考

yarn -v
1.6.0

npm -v
5.6.0

Answer 13

注意：此方法会即时修改您的package.json，如果您别无选择，请使用它。

我必须将命令行参数传递给我的脚本，类似于：

"scripts": {
    "start": "npm run build && npm run watch",
    "watch": "concurrently  \"npm run watch-ts\" \"npm run watch-node\"",
    ...
}

所以，这意味着我以npm run start 启动我的应用程序。

现在如果我想传递一些参数，我会从可能开始：

npm run start -- --config=someConfig

它的作用是：npm run build && npm run watch -- --config=someConfig。问题在于，它总是将参数附加到脚本的末尾。这意味着所有链接的脚本都没有得到这些参数（Args 可能是也可能不是所有人都需要，但那是另一回事。）。此外，当调用链接脚本时，这些脚本将不会获得传递的参数。即watch 脚本不会获取传递的参数。

我的应用程序的生产用途是.exe，因此在 exe 中传递参数可以正常工作，但如果想在开发期间执行此操作，则会出现问题。

我找不到任何合适的方法来实现这一点，所以这是我尝试过的。

我创建了一个 javascript 文件：start-script.js 在应用程序的父级，我有一个“default.package.json”，而不是维护“package.json”，我维护“default.package.json” . start-script.json 的目的是读取default.package.json，提取scripts 并查找npm run scriptname，然后将传递的参数附加到这些脚本中。之后，它将创建一个新的package.json 并使用修改后的脚本从 default.package.json 复制数据，然后调用npm run start。

const fs = require('fs');
const { spawn } = require('child_process');

// open default.package.json
const defaultPackage = fs.readFileSync('./default.package.json');
try {
    const packageOb = JSON.parse(defaultPackage);
    // loop over the scripts present in this object, edit them with flags
    if ('scripts' in packageOb && process.argv.length > 2) {

        const passedFlags = ` -- ${process.argv.slice(2).join(' ')}`;
        // assuming the script names have words, : or -, modify the regex if required.
        const regexPattern = /(npm run [\w:-]*)/g;
        const scriptsWithFlags = Object.entries(packageOb.scripts).reduce((acc, [key, value]) => {
            const patternMatches = value.match(regexPattern);
            // loop over all the matched strings and attach the desired flags.
            if (patternMatches) {
                for (let eachMatchedPattern of patternMatches) {
                    const startIndex = value.indexOf(eachMatchedPattern);
                    const endIndex = startIndex + eachMatchedPattern.length;
                    // save the string which doen't fall in this matched pattern range.
                    value = value.slice(0, startIndex) + eachMatchedPattern + passedFlags + value.slice(endIndex);
                }
            }
            acc[key] = value;
            return acc;
        }, {});
        packageOb.scripts = scriptsWithFlags;
    }

    const modifiedJSON = JSON.stringify(packageOb, null, 4);
    fs.writeFileSync('./package.json', modifiedJSON);

    // now run your npm start script
    let cmd = 'npm';
    // check if this works in your OS
    if (process.platform === 'win32') {
        cmd = 'npm.cmd';    // https://github.com/nodejs/node/issues/3675
    }
    spawn(cmd, ['run', 'start'], { stdio: 'inherit' });

} catch(e) {
    console.log('Error while parsing default.package.json', e);
}

现在，我不做npm run start，而是做node start-script.js --c=somethis --r=somethingElse

初始运行看起来不错，但尚未彻底测试。如果您喜欢自己的应用程序开发，请使用它。

Answer 14

我发现可以像向 Node.js 一样传递变量：

// index.js
console.log(process.env.TEST_ENV_VAR)

// package.json
...
"scripts": { "start": "node index.js" },
...

TEST_ENV_VAR=hello npm start

打印出“你好”

Answer 15

据我所知，当人们想以更简单的方式运行脚本时，他们会使用 package.json 脚本。例如，要使用安装在本地node_modules中的nodemon，我们不能直接从cli调用nodemon，但可以使用./node_modules/nodemon/nodemon.js调用。所以，为了简化这个冗长的输入，我们可以把这个...

... 脚本：{ '开始'：'nodemon app.js' } ...

...然后调用npm start 以使用以app.js 作为第一个参数的'nodemon'。

我想说的是，如果您只想使用node 命令启动服务器，我认为您不需要使用scripts。键入 npm start 或 node app.js 具有相同的效果。

但是如果你确实想使用nodemon，并且想传递一个动态参数，也不要使用script。尝试使用符号链接。

例如使用带有sequelize 的迁移。我创建了一个符号链接...

ln -s node_modules/sequelize/bin/sequelize sequelize

...当我调用它时，我可以通过任何争论...

./sequlize -h /* show help */

./sequelize -m /* upgrade migration */

./sequelize -m -u /* downgrade migration */

等等……

在这一点上，使用符号链接是我能想到的最好方法，但我并不认为这是最好的做法。

我也希望你对我的回答发表意见。

Answer 16

我知道已经有一个认可的答案，但我有点喜欢这种 JSON 方法。

npm start '{"PROJECT_NAME_STR":"my amazing stuff", "CRAZY_ARR":[0,7,"hungry"], "MAGICAL_NUMBER_INT": 42, "THING_BOO":true}';

通常我需要 1 个变量，例如项目名称，所以我觉得这很简单。

我的 package.json 中也经常有类似的东西

"scripts": {
    "start": "NODE_ENV=development node local.js"
}

贪婪我想要“全部”，NODE_ENV 和 CMD 行 arg 的东西。

您只需在文件中访问这些内容（在我的情况下为 local.js）

console.log(process.env.NODE_ENV, starter_obj.CRAZY_ARR, starter_obj.PROJECT_NAME_STR, starter_obj.MAGICAL_NUMBER_INT, starter_obj.THING_BOO);

你只需要在它上面有这个位（我正在运行 v10.16.0 btw）

var starter_obj = JSON.parse(JSON.parse(process.env.npm_config_argv).remain[0]);

Anyhoo，问题已经回答了。我想我会分享，因为我经常使用这种方法。

Answer 17

npm run script_target -- 基本上这是传递命令行参数的方式，但它只在脚本只有一个命令运行的情况下才有效，就像我正在运行一个命令一样即 npm run start -- 4200

"script":{
       "start" : "ng serve --port="
 }

这将运行以传递命令行参数，但如果我们一起运行多个命令，例如 npm run build c:/workspace/file

"script":{
       "build" : "copy c:/file <arg> && ng build"
 } 

但它会在运行时像这样解释 copy c:/file && ng build c:/work space/file 我们应该是这样的 复制 c:/file c:/work space/file && ng build

注意：- 所以命令行参数仅在脚本中只有一个命令的情况下才有效。

我阅读了上面的一些答案，其中一些人写道，您可以使用 $ 符号访问命令行参数，但这不起作用

Answer 18

我解决了这样的问题，看看test-watch 脚本：

"scripts": {
    "dev": "tsc-watch --onSuccess \"node ./dist/server.js\"",
    "test": "tsc && cross-env NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 jest",
    "test-watch": "cross-env NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 tsc-watch --onSuccess",
  },

您像这样调用test-watch 脚本：

// Run all tests with odata in their name
npm run test-watch "jest odata"