将参数从脚本传递给 gulp 任务

I have package.json具有以下结构的脚本：

"scripts": {
    "watch:build": "tsc --watch",
    "watch:server": "nodemon ./src/app.js --watch 'app'",
    "build": "tsc && gulp do_something",
    "start": "npm-run-all clean build --parallel watch:build", 
    "watch:server --print-label"
}

我想启动应用程序npm run start with_argument并将其传递给build脚本，根据该参数在 gulp 任务中执行操作。

我读了很多教程和如何文章，但没有结果。可以以某种方式将参数从一个脚本传递到另一个脚本（这会启动 gulp 任务）。

提前致谢！

npm-run-all提供了自己的自定义机制，通过利用 npm-scripts 中的占位符来处理参数，如参数占位符找到其文档部分here https://github.com/mysticatea/npm-run-all/blob/HEAD/docs/npm-run-all.md#argument-placeholders.

npm 脚本：

鉴于您当前的 npm 脚本名为start您需要按如下方式重新定义它：

"scripts": {
  ...
  "start": "npm-run-all clean \"build -- {@}\" --parallel watch:build --"
  ...
}

Notes:

• -- {@} must be added after build.¹
• build -- {@}必须用转义双引号引起来\"...\"
• --还必须在最后一次脚本调用之后添加，即：watch:build

gulpfile.js

要获取通过 CLI 内部传递的参数gulpfile.js你需要利用节点process.argv https://nodejs.org/docs/latest/api/process.html#process_process_argv

为了演示的目的，让我们说我们的gulpfile.js如下：

var gulp = require('gulp');
var args = process.argv.splice(3, process.argv.length - 3);

gulp.task('doSomething', function() {

  // For testing purposes...
  if (args.indexOf('--foo') > -1) {
    console.log('--foo was passed via the CLI.')
  }

  if (args.indexOf('--quux') > -1) {
    console.log('--quux was passed via the CLI.')
  }
});

Notes:

1. 节点中的前三项process.argv are:

   • 运行 JavaScript 文件的可执行文件的路径。
   • 正在执行的 JavaScript 文件的路径。
   • gulp 任务的名称，即doSomething

2. 但是，我们只对数组中第四项以后的元素感兴趣 - 因为这些将是通过 CLI 传递的参数。这行内容如下：

   var args = process.argv.splice(3, process.argv.length - 3);
   

   创建一个args变量并分配一个包含通过 CLI 传递的每个参数的数组，即我们使用数组省略了上面第 1 点中提到的前三个项目splice() https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice method.

运行你的start script:

您可以通过 CLI 调用启动脚本，如下所示：

$ npm start -- --foo --quux

Note您必须提供--其先于npm start在提供你自己的论点之前。

Output:

• 使用人为的gulpfile.js上面，结合您当前定义的脚本包.json，当然还有对您的start脚本。当你跑步时：

  $ npm start -- --foo --quux
  

  您将看到以下内容打印到控制台：

  --foo was passed via the CLI.

  --quux was passed via the CLI.

• Running:

  $ npm start -- --quux
  

  您将看到以下内容打印到控制台：

  --quux was passed via the CLI.

• 当然，运行：

  $ npm start
  

  不打印中定义的任何消息gulpfile.js.

_Footnotes:

1 _{-- {@} can be replaced with -- {1} if you only intend to pass one argument. However, -- {@} handles multiple arguments, so it's fine to use it for one argument too.}