查看原文
其他

17.6K Star! 一款快速高效的包管理工具

王龙 开源前哨 2022-09-24

简介

pnpm 是一个快速的、节省磁盘空间的包管理工具。pnpm 使用内容寻址的文件系统来存储磁盘上的所有模块文件

项目地址

https://github.com/pnpm/pnpm

安装

  • 使用 npm

    npm install -g pnpm
  • 使用 Homebrew

    如果你已经安装了 Homebrew 软件包管理器,则可以使用如下命令赖安装 pnpm:

    brew install pnpm

兼容性

下图列出了以往的 pnpm 版本和对应支持的 Node.js 版本

命令

以下是与 npm 等价命令的对照表:

npm 命令pnpm 等价命令
npm installpnpm install
npm ipnpm add
npm runpnpm

特点

  • 速度快

    pnpm 相较于 npm/yarn 两个常用的包管理工具性能得到大幅提升,下图为官方提供的基准测试数据      

  • 节省磁盘空间

    pnpm 内部使用内容寻址的文件系统来存储磁盘上所有的文件

    1、使用 npm/yarn 时,如果你有 100 个项目,并且所有项目都有一个相同的依赖包,那么, 你在硬盘上就需要保存 100 份该相同依赖包的副本,但是pnpm会只在一个地方写入这部分代码,后面使用会直接使用hard link,不会占用额外的磁盘空间

    2、当这个依赖包需要更新到新版本时,并且新版本中只有一个文件有修改。pnpm 并不会重新写入101个文件,而是保留原来的 100 个文件的 hard link,仅仅写入那一个新增的文件到存储中

依赖管理

pnpm 采用Hard link (硬链接)和 Symbolic Link(符号链接)来创建依赖关系的嵌套结构

假设安装foo@1.0.0依赖于bar@1.0.0,  pnmp 会将这两个包硬链接到node_modules

node_modules
└── .pnpm
    ├── bar@1.0.0
    │   └── node_modules
    │       └── bar -> <store>/bar
    │           ├── index.js
    │           └── package.json
    └── foo@1.0.0
        └── node_modules
            └── foo -> <store>/foo
                ├── index.js
                └── package.json                

一旦所有的包都被硬链接到node_modules ,符号链接就会被用来构建嵌套依赖关系图

你可能已经注意到了,这两个包都硬链接到一个node_modules 文件夹 ( foo@1.0.0/node_modules/foo)的子文件夹中。这是为了:

  1. 允许包能import自身。 foo  可以require('foo/package.json')import * as package from "foo/package.json"

  2. 避免循环符号链接。 包的依赖关系被放置在依赖包所在文件夹中。对于 Node.js 来说,依赖项是放在在包的node_modules中还是在某个父级目录的node-modules中是没有区别的

下一步,安装符号链接依赖。bar 被符号链接到foo@1.0.0/node_modules文件夹:

node_modules
└── .pnpm
    ├── bar@1.0.0
    │   └── node_modules
    │       └── bar -> <store>/bar
    └── foo@1.0.0
        └── node_modules
            ├── foo -> <store>/foo
            └── bar -> ../../bar@1.0.0/node_modules/bar

接下来,处理直接依赖关系。foo 将被符号链接到node_modules根文件夹,因为foo是项目的依赖项:

node_modules
├── foo -> ./.pnpm/foo@1.0.0/node_modules/foo
└── .pnpm
    ├── bar@1.0.0
    │   └── node_modules
    │       └── bar -> <store>/bar
    └── foo@1.0.0
        └── node_modules
            ├── foo -> <store>/foo
            └── bar -> ../../bar@1.0.0/node_modules/bar

这是一个非常简单的例子。 不过,无论依赖项的数量和依赖关系图的深度如何,布局都会保持这种结构。

如果这时,添加qar@2.0.0barfoo的依赖项:

node_modules
├── foo -> ./.pnpm/foo@1.0.0/node_modules/foo
└── .pnpm
    ├── bar@1.0.0
    │   └── node_modules
    │       ├── bar -> <store>/bar
    │       └── qar -> ../../qar@2.0.0/node_modules/qar
    ├── foo@1.0.0
    │   └── node_modules
    │       ├── foo -> <store>/foo
    │       ├── bar -> ../../bar@1.0.0/node_modules/bar
    │       └── qar -> ../../qar@2.0.0/node_modules/qar
    └── qar@2.0.0
        └── node_modules
            └── qar -> <store>/qar

如你所见,即使图现在更深(foo > bar > qar),文件系统中的目录深度仍然相同。

这种布局乍一看可能很奇怪,但其实它是完全兼容 Node 的模块解析算法的!node_modules 根目录中的包只是一个符号链接。require('foo') 将执行 node_modules/.pnpm/foo@1.0.0/node_modules/foo/indexjs 中的文件(这里是硬链接),而不是 node_modules/foo/index.js 中的文件。

严格性

这种布局的一大好处是只有真正在依赖项中的包才能访问。如果是使用扁平化的 node_modules 结构,程序可以访问到一些不在package.json依赖中的包。这可以避免一些愚蠢的错误[1]

参考资料

[1]

一些愚蠢的错误: https://www.kochan.io/nodejs/pnpms-strictness-helps-to-avoid-silly-bugs.html

- EOF - 

加前哨君微信,发现更多开源资源

主页君日常还会在个人微信分享开源工具资源精选技术文章,不定期分享一些有意思的活动岗位内推以及如何用技术做业余项目

加个微信,打开一扇窗

更多优秀开源项目(点击下方图片可跳转)


开源前哨

日常分享热门、有趣和实用的开源项目。参与维护10万+star 的开源技术资源库,包括:Python, Java, C/C++, Go, JS, CSS, Node.js, PHP, .NET 等

关注后获取

回复 资源 获取 10万+ star 开源资源


分享点赞在看

支持我们分享更多优秀开源项目,谢谢!

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存