我们都知道 npm install
,但有些人可能不知道 npm ci
(全新安装)。此命令在 CI
环境中非常有用。使用 npm ci
可以使你的构建管道更快、更稳定。
学习这些命令可以帮助你更好地了解 npm install
以及为什么 package-lock.json
和 package.json
如此重要。了解这些基础知识可以让你更清晰地了解。
什么是 npm ci(全新安装)?
npm ci
是用于在项目中安装依赖项的命令,注重速度和一致性。它在持续集成 (CI
) 设置中特别有用。
它与 npm install 有何不同?
-
更快的安装:
npm ci
跳过更新package-lock.json
。它严格遵循锁定文件的依赖项,使过程更快、更可预测。 -
严格锁定文件:
它使用
package-lock.json
中的确切依赖项版本。如果package.json
和package-lock.json
之间存在任何不匹配,它将引发错误。这可确保所有环境(本地、CI
、生产)使用相同的依赖项。 -
全新安装:
在安装之前,
npm ci
会删除node_modules
文件夹以重新开始。
何时使用?
CI/CD
管道:非常适合需要快速、一致安装而无需更新的自动构建系统。- 受信任的锁定文件:当你希望依赖项与
package-lock.json
中定义的内容完全匹配时使用。 - 这里有一个快速参考表,通过了解
npm install
和npm ci
之间的主要区别,可以为你打开许多隐藏的区域:
内容 | npm install | npm ci |
---|---|---|
1. 依赖解析 | 根据 package.json 解析依赖项并更新 package-lock.json 以反映任何更改。 | 跳过解析,使用 package-lock.json 中的精确版本,而不参考 package.json 了解版本范围。 |
2. 版本兼容性检查 | 确保依赖项满足 package.json 中指定的范围,如果需要则更新 package-lock.json。 | 要求 package-lock.json 中的版本与 package.json 完全匹配;如果不同步则失败。 |
3. node_modules 清理 | 仅安装缺失或更新的软件包而不删除 node_modules,保留未更改的现有依赖项。 | 在重新安装所有内容之前,完全删除 node_modules。 |
4. 锁文件生成 | 如果不存在 package-lock.json,则生成新的;根据 package.json 更改对其进行更新。 | 需要现有的 package-lock.json,如果缺失或与 package.json 不同步则失败。 |
5. 与 package.json 同步 | 更新 package-lock.json 以与 package.json 中任何新的、修改的或删除的依赖项保持一致。 | 要求 package-lock.json 与 package.json 完全匹配;如果不匹配,则失败,以确保严格的版本一致性。 |
6. 安装依赖项 | 根据 package.json 将依赖项安装到 node_modules 中,使用任何已解析的版本更新 package-lock.json。 | 完全按照 package-lock.json 中指定的方式安装依赖项,确保可重复性并忽略 package.json 中的版本范围。 |
7. 锁文件修改 | 修改 package-lock.json 以自动匹配 package.json 更改。 | 无论 package.json 如何更改,都不会修改 package-lock.json,从而保持一致性。 |
8. 网络请求 | 获取 node_modules 中未找到的任何新依赖项或更新。 | 仅获取 package-lock.json 中列出的依赖项,跳过其他检查。 |
9. 速度 | 由于依赖项解析、潜在的锁文件更新和增量安装,速度较慢。 | 速度更快,仅使用 package-lock.json 进行精确安装,最大程度减少处理。 |
10. 文件优先级 | package.json 优先:依赖关系基于它进行解析,并且 package-lock.json 会更新以反映任何更改。 | package-lock.json 优先:安装使用来自它的精确版本,忽略 package.json,除非检查同步错误(如果不匹配则失败)。 |
11. 理想用例 | 最适合修改或添加依赖项时的本地开发。 | 最适合 CI/CD 环境、生产或一致性、速度和可重复性至关重要的任何情况。 |