npm5今天发布,其中一个新特性包括通过创建package-lock.json文件进行确定性安装。
这个文件应该保存在源代码管理中吗?
我假设它类似于yarn.lock和composer.lock,它们都应该保存在源代码控制中。
npm5今天发布,其中一个新特性包括通过创建package-lock.json文件进行确定性安装。
这个文件应该保存在源代码管理中吗?
我假设它类似于yarn.lock和composer.lock,它们都应该保存在源代码控制中。
当前回答
所有答案都说“是”,但这也取决于项目,医生说:
package-lock.json的一个关键细节是它不能被发布,如果在顶层包之外的任何地方找到它,就会被忽略。
这意味着你不需要在npm上发布依赖的package-lock.json,但你需要在repo中使用package-llock.json来锁定测试依赖的版本,构建依赖…
但是,如果您使用lerna来管理具有多个包的项目,那么应该只将package.json放在repo的根目录上,而不是放在每个子包中。你会得到这样的结果:
.git
lerna.json
package.json
package-lock.json <--- here
packages/a/package.json
packages/a/lib/index.js
packages/b/package.json
packages/b/lib/index.js
其他回答
是的,它打算被签入。我想建议它获得自己独特的提交。我们发现它给我们的差异增加了很多噪音。
是的,提交package-lock.json是一种标准做法。
提交package-lock.json的主要原因是项目中的每个人都使用相同的包版本。
赞成的意见:
如果您遵循严格的版本控制,并且不允许自动更新到主要版本,以避免在第三方包中发生向后不兼容的更改,那么提交包锁定会有很大帮助。如果您更新了一个特定的包,它会在package-lock.json中更新,并且使用存储库的每个人在接受您的更改时都会更新到该特定版本。
欺骗:
这会让你的拉取请求看起来很难看:)
npm安装无法确保项目中的每个人都使用相同的软件包版本。npm ci将对此有所帮助。
是的,package-lock.json打算签入源代码管理。如果您使用的是npm5+,您可能会在命令行上看到以下通知:创建了一个名为package-lock.json的锁定文件。您应该提交该文件。根据npm帮助package-lock.json:
package-lock.json是为npm所在的任何操作自动生成的修改node_modules树或package.json生成的确切树,以便后续安装能够生成相同的树,而不考虑中间的依赖关系更新。此文件旨在提交到源存储库中各种用途:描述依赖关系树的单一表示,以确保队友、部署和持续集成能够安装完全相同的依赖关系。为用户提供一种工具,让他们“时间旅行”到node_module的先前状态,而不必提交目录本身。通过可读的源代码控制差异,帮助提高树更改的可见性。并通过允许npm跳过先前安装的包的重复元数据解析来优化安装过程。package-lock.json的一个关键细节是它无法发布如果在顶层包以外的任何位置找到,将被忽略。它共享npm-shrinkwrap.json格式,基本上是相同的文件,但是允许发布。除非部署CLI工具或否则使用发布过程来生产生产包。如果package-lock.json和npm-shrinkwrap.json都存在于包package-lock.json将被完全忽略。
将package-lock.json提交到源代码版本控制意味着项目将使用特定版本的依赖项,该依赖项可能与package.json中定义的依赖项相匹配,也可能与之不匹配。虽然依赖项具有特定版本,但如您所见,没有任何Caret(^)和Tilde(~),这意味着依赖项不会更新到最新版本。npm install将获取当前版本Angular所需的相同版本。
注意:package-lock.json强烈建议在CI期间将任何Caret(^)和Tilde(~)添加到要更新的依赖项时提交它。
是的,您应该:
提交package-lock.json。在ci和本地开发计算机上构建应用程序时,请使用npm-ci而不是npm-install
npm-ci工作流要求存在package-lock.json。
npm install命令的一个大缺点是它的意外行为,即它可能会改变package-lock.json,而npm ci只使用锁定文件中指定的版本并产生错误
如果package-lock.json和package.json不同步如果缺少package-lock.json。
因此,在本地运行npm安装,特别是在具有多个开发人员的大型团队中,可能会导致package-lock.json内部发生大量冲突,开发人员决定完全删除package-llock.json。
然而,有一个强大的用例可以证明,项目的依赖关系可以在不同的机器上以可靠的方式重复解决。
从package-lock.json中,您可以得到确切的结果:已知工作状态。
过去,我有一些没有package-lock.json/npm-shrinkwrap.json/yarn.lock文件的项目,它们的构建有一天会失败,因为一个随机依赖项得到了破坏性的更新。
这些问题很难解决,因为您有时不得不猜测上一个工作版本是什么。
如果要添加新的依赖项,仍然可以运行npm install{dependency}。如果要升级,请使用npm update{dependency}或npm install${dependency}@{version}并提交更改的package-lock.json。
如果升级失败,您可以恢复到最后一个已知的工作包-lock.json。
引用npm文档:
强烈建议您将生成的包锁提交到源代码管理:这将允许团队中的任何其他人部署、您的CI/持续集成以及任何其他运行在包源中安装npm,以获得完全相同的依赖关系此外更改是人类可读的,并将通知您npm的任何更改设置为node_modules,因此您可以注意到依赖关系得到更新、提升等。
关于npm ci与npm install之间的区别:
项目必须具有现有的package-lock.json或npm-shrinkwrap.json。如果包锁中的依赖项与package.json中的依赖不匹配,npm-ci将退出并返回错误,而不是更新包裹锁。npmci一次只能安装整个项目:不能使用此命令添加单个依赖项。如果node_modules已经存在,则在npm-ci开始安装之前,它将被自动删除。它永远不会写入package.json或任何包锁:安装基本上是冻结的。
注:我在这里发布了类似的答案