简介
在编写前端项目的过程中，我们可能需要在本地或者远程服务器上运行一些自定义的脚本。这时候，我们可以使用 npm 包 @npmcli/run-script 来快捷地运行这些脚本。
@npmcli/run-script 是一个 npm 包，可以让我们在 package.json 中定义和执行自定义的命令。通过它，我们可以在项目根目录下通过命令行执行自己定义的命令。同时，它还提供了一些方便的 API，可以在 Node.js 中调用。
本篇文章将详细介绍 @npmcli/run-script 的使用方法，并提供实例代码帮助读者更好地理解。
安装
在项目根目录中运行以下命令：
--- ------- ------------------
使用
命令行执行
我们可以在 package.json 中定义自己的脚本，例如：
-
---------- -
-------- ------ --- --------- -----
------- ------ -------------
-
-然后，在命令行中执行以下命令：
--- --- ----- --- --- ----
这样就可以快速地执行我们定义好的脚本了。
API 调用
除了通过命令行执行，@npmcli/run-script 还提供了一些方便的 API 可以在 Node.js 中调用。
run
通过 run 方法可以在 Node.js 中调用自定义的脚本。例如，我们可以在 Node.js 中编写以下代码：
----- --- - ------------------------------------- -------------------- -- - ------------------ ------- --
这段代码将会执行我们在 package.json 中定义的 build 命令，并且在执行完成后输出 build done!。
spawn
如果我们需要在 Node.js 中调用自己的脚本并且传入一些参数，可以使用 spawn 方法。例如，我们在 Node.js 中编写以下代码：
----- ----- - ----------------------------------- ----- ----- - -------------- ------- ----------- ----------------- ---- -- - ------------------ ------ ---- ---- --------- --
这段代码将会执行我们在 package.json 中定义的 build 命令，并且接收从命令行传入的参数，最后输出 build exited with code 0。
深度解析
package.json 中 script 字段
在上文的例子中，我们可以看到自定义命令都定义在 package.json 的 scripts 字段中。这个字段中，可以包含任意个自定义脚本。
每个脚本都有一个名称和一个命令。命令可以是任何可由通用 shell 解释的脚本或命令，例如 npm 命令、shell 命令或其他脚本命令。
关于 NPM 环境变量
在执行自定义脚本时，有时候我们需要读取一些环境变量。这时候，需要注意 NPM 环境变量的使用方式。
对于在 package.json 中定义的每个脚本，NPM 都会将该脚本的路径添加到 PATH 环境变量中。在该脚本中，我们也可以通过获取 $npm_package_xxx 环境变量的方式，读取 package.json 中的内容。
然而，在我们执行自定义脚本时却不能直接使用环境变量，因为在运行脚本时，NPM 并没有为该脚本添加到 PATH 环境变量中。
解决这个问题的方法是通过在脚本中显式地通过 $PATH 环境变量来找到所需的程序或资源。例如，在以下例子中，我们需要调用 git：
-
---------- -
--------- ---- --- - -- --- -------
-
-但是，在执行 npm run commit 时，我们会得到一个错误：
--- ---- ------- --- -----
这个错误是因为在执行自定义脚本时，NPM 并没有将 git 的路径添加到 PATH 中。解决方法是显式地写出 git 的二进制文件的绝对路径：
-
---------- -
--------- ------------------- --- - -- ------------------ -------
-
-这样做就可以在自定义脚本中使用 git 了。
API 调用
@npmcli/run-script 在 API 调用方面提供了两个方法：run 和 spawn。
run
run 方法用于在 Node.js 中调用自定义脚本。在调用时，需要传入一个参数，即我们在 package.json 中定义的脚本名称。
run 方法会返回一个 Promise 对象，在 Promise 成功时，表示自定义脚本顺利执行结束；在 Promise 失败时，表示执行过程中出现了异常。
以上面的 build 为例，在 Node.js 中进行调用可以这样写：
----- --- - ------------------------------------- -------------------- -- - ------------------ ------- --
这段代码将会执行我们在 package.json 中定义的 build 命令，并且在执行完成后输出 build done!。
spawn
spawn 方法和 run 方法类似，也用于在 Node.js 中调用自定义脚本。不同之处是，spawn 方法可以接收一个数组作为参数，在数组中指定需要传入的参数。
在使用 spawn 方法时，我们需要注意一些细节。首先，我们需要引入 child_process 模块中的 spawn 方法。其次，我们需要将 spawn 方法的第一个参数设置为自定义脚本的名称。最后，我们需要设置一个 stdio 属性为 'inherit'，这是由于 spawn 方法会创建一个子进程，并且我们需要在控制台中看到该子进程的输出。
以 build 命令为例：
----- ----- - ----------------------------------- ----- ----- - -------------- ------- ----------- ----------------- ---- -- - ------------------ ------ ---- ---- --------- --
这段代码将会执行我们在 package.json 中定义的 build 命令，并且接收从命令行传入的参数，最后输出 build exited with code 0。
总结
本文详细介绍了如何使用 @npmcli/run-script 在命令行和 Node.js 中调用自己定义的脚本。同时，我们还介绍了一些注意事项和细节，帮助读者更好地理解并使用该工具。希望读者能够对 @npmcli/run-script 有更深入的理解，从而提高前端项目开发的效率。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5eedc51eb5cbfe1ea06121e0