从入门到传参：package.json 之 npm run scripts命令的奥秘

一、入门：了解package.json

package.json 文件是每个 Node.js 项目的基础。它包含项目信息，如名称、版本和依赖项。您还可以在其中定义脚本，这些脚本可以在命令行中使用 npm run 命令运行。

要在 package.json 文件中定义脚本，您需要在 "scripts" 字段下添加一个新键。键是脚本的名称，值是您希望在运行脚本时执行的命令。例如，以下代码定义了一个名为 "start" 的脚本，该脚本将启动项目：

{
  "scripts": {
    "start": "node index.js"
  }
}

要运行此脚本，您可以使用以下命令：

npm run start

二、进阶：npm scripts传参

npm scripts 允许您向脚本传递参数，以便您可以更轻松地自定义脚本的行为。有两种方法可以做到这一点：

1. npm config 变量

npm config 变量允许您在运行脚本时设置环境变量。要设置环境变量，您可以使用以下命令：

npm config set <variable name> <value>

例如，以下命令设置名为 "MY_VARIABLE" 的环境变量的值为 "my value"：

npm config set MY_VARIABLE my value

然后，您可以在脚本中使用 {MY_VARIABLE} 变量来访问环境变量的值。例如，以下脚本使用 {MY_VARIABLE} 变量来打印环境变量的值：

#!/bin/bash

echo ${MY_VARIABLE}

2. shell 变量

shell 变量允许您在运行脚本时设置 shell 变量。要设置 shell 变量，您可以使用以下命令：

export <variable name>=<value>

例如，以下命令设置名为 "MY_VARIABLE" 的 shell 变量的值为 "my value"：

export MY_VARIABLE=my value

然后，您可以在脚本中使用 MY_VARIABLE 变量来访问 shell 变量的值。例如，以下脚本使用 MY_VARIABLE 变量来打印 shell 变量的值：

#!/bin/bash

echo $MY_VARIABLE

三、应用：优雅传参

有了这些基础知识，您就可以开始向 npm run scripts 命令传递参数了。以下是一些用例：

• 传递配置参数 ：您可以使用 npm config 变量或 shell 变量来传递配置参数给脚本。例如，您可以传递数据库连接字符串或 API 密钥。
• 传递输入参数 ：您可以使用 npm config 变量或 shell 变量来传递输入参数给脚本。例如，您可以传递要处理的文件名或要执行的查询。
• 传递输出参数 ：您可以使用 npm config 变量或 shell 变量来传递输出参数给脚本。例如，您可以传递脚本生成的报告或日志文件。

四、结语

npm scripts 是一个强大的工具，可帮助您自动化和简化前端工作流程。通过向 npm run scripts 命令传递参数，您可以更轻松地自定义和控制脚本的行为。我希望本文能帮助您充分利用 npm scripts 的强大功能。