Node.js 中的 npm exec 命令

在本文中，我们将学习 Node.js 中的 npm exec 命令，包括其语法、组成部分、特性、用例等。

什么是 NPM？

NPM（Node 包管理器） 是 Node.js 自带的默认包管理器，它简化了 Node.js 应用程序可重用代码包的维护、安装和共享过程。它对于现代开发至关重要，因为它提供了广泛的开源包生态系统，使开发人员能够轻松地将功能集成到他们的项目中，从而节省时间和精力。

NPM 随 Node.js 自动安装，允许开发人员立即开始使用其功能。它使得在 Node.js 项目中安装必需的包和模块更加容易。包是文件的集合，通常包括模块所需的配置信息和功能。模块是易于集成到项目中的 JavaScript 库或工具，这使得开发人员能够根据独特的需求快速增强应用程序的功能。

什么是 npm exec？

npm exec 命令（首次引入于 npm v7）是一个强大的工具，用于执行 node_modules/.bin 目录中定义的二进制文件或脚本，或者全局可用的二进制文件或脚本。与修改 PATH 以包含这些可执行文件不同，npm exec 无需额外配置即可实现无缝访问。它对于在项目上下文中运行 npm 包提供的脚本非常有用。

npm exec 旨在简化脚本执行，它比 npx 更现代、更健壮，npx 在之前的 npm 版本中经常用于类似的任务。使用 npm exec 的开发人员可以获得更高的效率，并且与 npm 的依赖管理系统具有更好的兼容性。此外，它还增强了在执行与项目环境或全局安装的工具相关的命令时的控制力和可靠性。

语法

它具有以下语法：

• npm exec：用于执行本地 node_modules/.bin 目录中的二进制文件或脚本，或全局二进制文件或脚本（取决于设置）的命令。
• [<args>]：这些是可选参数，可用于定义要启动的二进制文件或脚本。它们可能包括命令行参数或特定于正在执行的命令的参数。

NPM 的主要组成部分

NPM exec 的几个主要组成部分如下：

• node_modules 中的二进制文件： NPM 允许您使用本地安装在 node_modules/.bin 目录中的二进制文件，而无需全局安装。这确保每个项目使用适合其依赖项的二进制文件版本。
• 脚本执行： 使用 NPM 命令启动脚本允许开发人员自动化流程并维护一致的项目环境。它确保所有贡献者使用相同的脚本和配置，从而减少了设置之间的差异。

npm exec 的主要特性

npm exec 的几个主要特性如下：

1. 项目特定的二进制文件：直接从本地 node_modules/.bin 文件夹执行二进制文件，无需手动调整环境变量或定义路径。这确保了项目特定依赖项的隔离。
2. 与全局包兼容：如果本地 node_modules 目录中不存在二进制文件，npm exec 可以无缝地回退到执行全局安装的包。
3. 支持参数和选项：它允许将自定义参数或选项传递给正在执行的二进制文件或脚本，这为定制命令行操作提供了灵活性。
4. 与 npm Scripts 集成：它与 npm Scripts 完全集成，从而可以轻松运行 package.json 文件 scripts 部分中提供的指令，增强了工作流程的一致性和自动化。

npm exec 的常见用例

npm exec 的几个用例如下：

1. 运行本地安装的二进制文件：使用 npm exec 从 node_modules/.bin 目录启动二进制文件，而无需全局安装它们。例如，运行项目特定的 linter 或测试框架。

2. 执行全局包：如果本地未找到二进制文件，npm exec 可以执行全局安装的包，这对于不同项目使用的工具很有用。

3. 将参数传递给二进制文件：为命令添加自定义参数或选项以获得更大的控制力。例如，

4. 与 npm Scripts 集成：在 package.json 中定义的 npm Scripts 中使用 npm exec 来简化复杂的工作流程。

5. 自动化 CI/CD 任务：在持续集成管道中使用 npm exec 来确保使用了项目特定的二进制文件，从而避免了与全局依赖项的冲突。

6. 特定于环境的命令：在项目依赖项的上下文中执行二进制文件，以确保跨开发环境的版本一致性。

7. 调试和开发工具：它可以快速执行 nodemon 和 ts-node 等程序，而无需关心它们的安装路径。

npm exec 可用的选项

npm exec 命令有几个有用的选项可用于自定义其行为，使其适用于广泛的使用场景。以下是对关键选项的更详细描述以及如何使用它们的示例。

1. -c 或 --call：此选项指定其后的参数应被解释为 shell 命令。这对于运行内联 shell 命令或组合命令非常有用。

• --call：指示 npm 将字符串“echo 'Hello, World!' && mkdir test_dir”视为 shell 命令。
• 命令“echo 'Hello, World!'”在终端显示一条消息。
• 运行 mkdir test_dir 以创建名为 test_dir 的目录。

此选项允许您链接命令或使用重定向或变量替换等 shell 功能。

2. -g 或 --global：此选项从全局安装的包而不是本地 node_modules 目录运行选定的二进制文件。当您需要一个全局安装的工具但又不想在每个项目中本地安装时，此选项非常有用。

• -g：它确保使用 nodemon 的全局版本，无论是否存在本地版本。
• nodemon：nodemon 是一个流行的实用程序，用于监视应用程序文件的更改并自动重新启动服务器。

这种技术非常适合 nodemon 和 npm-check-updates 等工具，这些工具通常跨多个项目使用，但不是项目特定的。

3. --：双破折号 (--) 指示 npm 停止处理其选项，并将任何附加参数直接传递给正在执行的二进制文件。当您调用的二进制文件需要自己的选项或标志时，这尤其有用。

• eslint：调用本地 ESLint 二进制文件。
• --：它告知 npm --fix 命令是为 ESLint 而不是 npm 准备的。
• --fix：一个特定于 ESLint 的标志，它尝试自动更正代码中发现的错误。

当处理接受复杂或冲突选项的工具时，此方法至关重要。

npm exec 的使用示例

npm exec 命令（npm 7 中引入）是从项目的 node_modules/.bin 目录运行二进制文件的简单灵活的方法。它确保您运行的命令使用为项目安装的版本，从而避免了全局安装的工具可能引起的版本不匹配问题。

示例 1：运行 Linter

假设您的项目需要 ESLint 作为开发依赖项来确保代码质量。执行以下命令来检查源代码中是否存在任何问题。

• eslint：eslint 是安装在 node_modules/.bin 中的 linter 二进制文件。
• src/：它指定包含 lint 文件的目录。

此命令可确保 ESLint 根据您 .eslintrc 配置文件中指定的标准，检查 src 文件夹中的代码是否存在错误、警告和样式不一致。与运行全局 eslint 不同，npm exec 确保项目依赖项正常工作。

示例 2：运行带参数的命令

您还可以为正在执行的命令提供其他参数。例如，要 lint 代码并自动修复问题（如果可能），请使用：

• --：指示 npm 将后续参数传递给正在执行的二进制文件（在本例中为 eslint）。
• --fix：一个特定于 ESLint 的输入，指示它自动应用可修复错误的代码修复。

当您使用此命令时，ESLint 不仅会检测问题，还会编辑代码来纠正诸如格式不一致或未使用的变量等问题，只要这些修复是安全的并且得到 linter 的支持。

结论

总而言之，npm exec 命令是执行 Node.js 项目中脚本和二进制文件的基本工具。它通过允许直接使用本地二进制文件来简化流程，避免了对全局安装的需求，这可能导致版本冲突。利用本地项目依赖项可以确保环境之间的一致性，这使其非常适合协作开发。npm exec 命令通过包含 --call 用于 shell 命令、-g 用于全局二进制文件以及 -- 用于直接将参数传递给命令等选项，提供了简化的功能和多功能性。这使其成为现代 JavaScript 开发的基本组成部分，可以优化工作流程并提高项目可维护性。