2019-03-31 什么是package-lock.json(官方文档解释)

描述

package-lock.json会自动为npm修改node_modules树或任何操作而生成package.json。它描述了生成的确切树,以便后续安装能够生成相同的树,而不管中间依赖性更新如何。

这个文件旨在被提交到源代码库,并提供各种用途:

描述依赖关系树的单一表示,以确保队友,部署和持续集成确保安装完全相同的依赖关系。

为用户提供一个设施,使其能够“前往”以前的状态,node_modules而不必提交目录本身。

通过可读的源代码控制差异来促进树更改的更大可见性。

并通过允许npm跳过先前安装的软件包的重复元数据分辨率来优化安装过程。

一个关键的细节package-lock.json是它不能被发布,并且如果在顶层包之外的任何地方发现它将被忽略。它与npm-shrinkwrap.json共享格式,它基本上是相同的文件,但允许发布。除非部署CLI工具或以其他方式使用发布过程来生产产品包,否则不建议这样做。

如果两个package-lock.json和npm-shrinkwrap.json存在于包的根,package-lock.json将被完全忽略。

文件格式

名称

包的名称,这是一个包锁。这必须与内容匹配 package.json。

包的版本,这是一个包锁。这必须与内容匹配 package.json。

lockfileVersion

整数版本,1从此文档的版本号开始,在生成此版本时使用其语义package-lock.json。

packageIntegrity

这是从创建的子资源完整性值package.json。不package.json应该进行预处理。子资源完整性字符串可以由模块生成 ssri

preserveSymlinks

表示安装是在NODE_PRESERVE_SYMLINKS启用环境变量的情况下完成的 。安装程序应该坚持该属性的值与该环境变量相匹配。

依赖

包名称到依赖对象的映射。依赖项对象具有以下属性:

这是一个说明符,它唯一标识了这个包,并且可以用来获取它的新副本。

捆绑的依赖关系:无论来源如何,这是纯粹用于信息目的的版本号。

注册表来源:这是一个版本号。(例如1.2.3)

git sources:这是一个解析commitit的git说明符。(例如git+https://example.com/foo/bar#115311855adb0789a0466714ed48a1499ffea97e)

http tarball来源:这是tarball的URL。(例如https://example.com/example-1.3.0.tgz)

本地tarball源码:这是tarball的文件URL。(例如file:///opt/storage/example-1.3.0.tgz)

本地链接源:这是链接的文件URL。(例如file:libs/our-module)

廉正

这是此资源的标准子资源完整性

对于捆绑的依赖项,不包括源代码。

对于注册表来源,这是integrity注册表提供的,或者没有提供SHA1的shasum。

对于git来源,这是我们克隆的特定提交散列。

对于远程tarball源,这是基于文件SHA512的完整性。

对于本地压缩包来源:这是一个基于文件SHA512的完整性字段。

解决

对于捆绑的依赖项,不包括源代码。

对于注册表来源,这是相对于注册表URL的tarball路径。如果tarball URL与注册表URL不在同一台服务器上,那么这是一个完整的URL。

捆绑

如果为true,则这是捆绑的依赖关系,并将由父模块进行安装。安装时,此模块将在提取阶段从父模块中提取,而不是作为单独的依赖项安装。

开发

如果为true,那么这个依赖是或者是顶层模块的开发依赖,或者是一个依赖的传递依赖。这对于既是顶级开发依赖性又是顶级非开发依赖性的传递依赖性的依赖性是错误的。

可选的

如果为true,那么这个依赖是或者是顶层模块的可选依赖,或者是一个可传递的依赖。对于既是顶层可选依赖项又有顶层非可选依赖项的传递依赖项的依赖项,这是错误的。

即使在当前平台上可以卸载,也应包含所有可选的依赖关系。

依赖

这个依赖关系的依赖关系,就像在顶层一样。

参考:https://docs.npmjs.com/files/package-lock.json

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容