听课笔记-包管理工具

代码共享方案

        我们已经学习了在JavaScript中可以通过模块化的方式将代码划分成一个个小的结构，在以后的开发中我们就可以通过模块化的方式来封装自己的代码，并且封装成一个工具； 这个工具我们可以让同事通过导入的方式来使用，甚至你可以分享给世界各地的程序员来使用，如果我们分享给世界上所有的程序员使用，有哪些方式呢?

方式一：  上传到GitHub上、其他程序员通过GitHub下载我们的代码手动的引用；

                （1）缺点是大家必须知道你的代码GitHub的地址，并且从GitHub上手动下载；

                （2）需要在自己的项目中手动的引用，并且管理相关的依赖；

                （3）不需要使用的时候，需要手动来删除相关的依赖；

                （4）当遇到版本升级或者切换时，需要重复上面的操作；

上面的方式虽然是有效的，但是这种传统的方式非常麻烦，并且容易出错；

方式二：使用一个专业的工具来管理我们的代码口、

                （1）我们通过工具将代码发布到特定的位置；

                （2）其他程序员直接通过工具来安装、升级、删除我们的工具代码;

npm

一、包管理工具npm

1、包管理工具npm
（1）Node Package Manager，也就是Node包管理器；

（2）但是目前不仅仅是Node包管理器了，在前端项目中我们也在使用它来管理依赖的包；比如 vue、vue-router、vuex. express、 koa、react、 react-dom、 axios、babel、webpack等等；

2、下载和安装npm工具

（1） npm属于node的一个管理工具，所以我们需要先安装Node;

（2） node管理工具：https://nodejs.org/en/，安装Node的过程会自动安装npm工具；

3、npm管理的包查看、搜索

 http://  https://www.npmjs.org/     这是我们安装相关的npm包的官网；

4、npm管理的包存放的位置

（1）我们发布自己的包其实是发布到registry上面的；

（2）当我们安装一个包时其实是从registry上面下载的包；

二、npm的配置文件

1、使用npm来管理多个包

（1）我们每一个项目都会有一个对应的配置文件，无论是前端项目 (Vue、React) 还是后端项目 (Node)；

（2）这个配置文件会记录着你项目的名称、版本号、项目描述等；

（3）也会记录着你项目所依赖的其他库的信息和依赖库的版本号；

2、这个配置文件就是package.json
      那么这个配置文件如何得到呢?

（1）方式一：手动从零创建项目，npm init -y（写-y默认直接创建，不用填选项）

（2）方式二：通过脚手架创建项目，脚手架会帮助我们生成package.json，并且里面有相关的配置

三、常见的属性

1、必须填写的属性：

（1） name是项目的名称；

（2） version是当前项目的版本号；

（3） description是描述信息，很多时候是作为项目的基本描述；

（4） author是作者相关信息（发布时用到）；

（5）license是开源协议（发布时用到）；

2、 private属性:

（1） private属性记录当前的项目是否是私有的；

          当值为true时，npm是不能发布它的，这是防止私有项目或模块发布出去的方式;

 3、 main属性：

（1）设置程序的入口。

 比如我们使用axios模块 const axios = require('axios');

 如果有main属性，实际上是找到对应的main属性查找文件的；（如下图）

4、 scripts属性

（1） scripts属性用于配置一些脚本命令，以键值对的形式存在；

（2） 配置后我们可以通过 npm run 命令的key来执行这个命令；

（3） npm start和npm run start的区别

           它们具等价的·

           对于常用的 start、test、 stop、restart可以省略掉run直接通过 npm start等方式运行；

5、dependencies属性

（1）dependencies属性是指定无论开发环境还是生成环境都需要依赖的包；

（2）通常是我们项目实际开发用到的一些库模块vue、vuex、vue-router、react、react-dom、                axios等等； 与之对应的是devDependencies;

6、devDependencies属性

（1） 一些包在生产环境是不需要的，比如webpack、babel等；

（2）这个时候我们会通过 npm install webpack --save-dev, 将它安装到devDependencies属性中；

7、 peerDependencies属性

（1） 还有一种项目依赖关系是对等依赖，也就是你依赖的一个包，它必须是以另外一个宿主包为前提的，比如element-plus是依赖于vue3的,ant design是依赖于react、react-dom;

四、依赖的版本管理

我们会发现安装的依赖版本出现：^2.0.3或 ~2.0.3，其中的含义：

1、npm的包通常需要遵从semver版本规范：
         semver: https://semver.org/lang/zh-CN/
         npm semver: https://docs.npmjs.com/misc/semver

2、 semver版本规范是X.Y.Z

（1） X主版本号 (major)：当你做了不兼容的 API 修改 （可能不兼容之前的版本）；

（2） Y次版本号(minor)：当你做了向下兼容的功能性新增（新功能增加，但是兼容之前的版本）

（3） Z修订号 (patch)：当你做了向下兼容的问题修正（没有新功能，修复了之前版本的bug)；

3、^ 和 ~ 的区别：

（1）x.y.z:表示一个明确的版本号；

（2）^x.y.z：表示x是保持不变的，y和z永远安装最新的版本；

（3）~x.y.z：表示x和y保持不变的，Z永远安装最新的版本；

五、npm install命令

1、安装npm包的两种情况：

（1）全局安装  (global install):npm install webpack -g;

（2）项目（局部） 安装(local install):npm install webpack

2、全局安装：全局安装是直接将某个包安装到全局

                比如全局安装yarn：npm install yarn -g

3、全局安装的用法理解：

（1） 通常使用npm全局安装的包都是一些工具包：yarn、webpack等；

（2）并不是类似于 axios、express、koa等库文件；

（3）所以全局安装了之后并不能让我们在所有的项目中使用 axios等库；

六、项目安装

1、项目安装会在当前目录下生成一个 node modules 文件夹

2、局部安装分为开发时依赖和生产时依赖：

# 默认安装开发和生产依赖

npm install axios 或 npm i axios

# 开发依赖

npm install webpack --save-dev
npm install webpack -D
npm i webpack -D

# 根据package.json中的依赖包
npm install

七、package-lock.json

1、package-lock.json文件解析:

（1）name：项目的名称；

（2）version：项目的版本；

（3）lockfileVersion: lock文件的版本；

（4）requires:使用requires来跟踪模块的依赖关系;

（5）dependencies:项目的依赖

                当前项目依赖axios，但是axios依赖follow-redireacts;

                 axios中的属性如下：

                 version表示实际安装的axios的版本；

                 resolved用来记录下载的地址，registry仓库中的位置；

                 requires/dependencies记录当前模块的依赖；

                 integrity用来从缓存中获取索引，再通过索引去获取压缩包文件；

 

八、npm install 原理解析

npm install会检测是有package-lock.json文件：

1、没有lock文件

（1） 分析依赖关系，这是因为我们可能包会依赖其他的包，并且多个包之间会产生相同依赖的情况；

（2）从registry仓库中下载压缩包（如果我们设置了镜像，那么会从镜像服务器下载压缩包）；

（3） 获取到压缩包后会对压缩包进行缓存(从npm5开始有的）；

（4） 将压缩包解压到项目的node modules文件夹中（前面我们讲过,require的查找顺序会在该包下面查找）

2、有lock文件

（1）检测lock中包的版本是否和package.json中一致（会按照semver版本规范检测）；

             >不一致，那么会重新构建依赖关系，直接会走顶层的流程;

（2） 一致的情况下，会去优先查找缓存

            > 没有找到，会从registry仓库下载，直接走顶层流程；

            > 查找到，会获取缓存中的压缩文件，并且将压缩文件解压到node modules文件夹中；

九、npm其他命令

比较常用的：

1、卸载某个依赖包：

npm uninstall package

npm uninstall package --save-dev

npm uninstall package -D

2、强制重新build

npm rebuild

3、 清除缓存

npm cache clean

4、npm的命令其实是非常多的：

https://docs.npmis.com/cli-documentation/cli   更多的命令，可以根据需要查阅官方文档

十、npm发布自己的包

1、注册npm账号： https://www.npmjs.com/  选择sign up

2、在命令行登录（输入）：npm login

3、修改package.json（配置信息）

4、发布到npm registry上（输入）：npm publish

补充：

1、更新仓库：

（1）修改版本号（最好符合semver规范）

（2）2.重新发布

2、删除发布的包：npm unpublish

3、让发布的包过期：npm deprecate

yarn

一、yarn工具

1、另一个node包管理工具yarn:

（1）yarn是由Facebook、Google、Exponent 和 Tilde 联合推出了一个新的JS 包管理工具；

（2）yarn 是为了弥补 早期npm 的一些缺陷而出现的；

（3）早期的npm存在很多的缺陷，比如安装依赖速度很慢、版本依赖混乱等等一系列的问题；

（4）npm 和 yarn 命令对比

cnpm

一、cnpm工具

1、由于一些特殊的原因，某些情况下我们没办法很好的从 https://registry.npmjs.org下载下来一些需要的包。

2、查看npm镜像：
        npm config get registry # npm config get registry

3、我们可以直接设置npm的镜像：
        npm config set registry https://registry.npm. taobao.org

4、但是对于大多数人来说 ，并不希望将npm镜像修改了：

     （1）不太希望随意修改npm原本从官方下来包的渠道；

     （2）第二，担心某天淘宝的镜像挂了或者不维护了，又要改来改去

  这个时候，我们可以使用cnpm，并且将cnpm设置为淘宝的镜像：
        npm install -g cnpm --registry=https://registry.npm. taobao.org
        cnpm config get registry # https://r.npm. taobao.org/

npx

一、npx工具

1、npx是npm5.2之后自带的一个命令。npx的作用非常多，但是比较常见的是使用它来调用项目中的某个模块的指令。

2、以dayjs为例：

 全局安装的是dayjs1.11.1
 项目安装的是dayjs1.8.12

如果在终端执行 webpack --version  显示结果会是 dayjs1.11.1，事实上使用的是全局的，原因非常简单，在当前目录下找不到dayjs时，就会去全局找，并且执行命令；

3、解决这个问题的方式（局部命令的执行）如何使用项目（局部）的dayjs?

（1）方式一：明确查找到node module下面的webpack

                在终端中使用如下命令（在项目根目录下）

                ./node_modules/.bin/dayjs --version

（2） 方式二：在 scripts定义脚本，来执行dayjs;

                "scripts" ：{"dayjs" ："dayjs --version"}

（3） 方式三：使用npx

                npx dayjs --version

 npx的原理很简单，它会到当前目录的node modules/.bin目录下查找对应的命令；

pnpm

一、pnpm简介

1、pnpm：可以理解为performant npm缩写

2、优点：

（1）快速：比其他包快两倍

（2）高效：node_modules中的文件链接自特定的内容寻址储存库

（3）支持monorepos ：pnpm内置支持单仓多包

（4）严格：pnpm默认创建了一个非平铺的node_modles，因此代码无法访问任何包

二、硬链接和软连接的概念

1、硬链接(hard link):
（1）硬链接（英语： hard link) 是电脑文件系统中的多个文件平等共享同一个文件存储单元；

（2） 删除一个文件名字后，还可以用其它名字继续访问该文件。

2、符号链接（软链接soft link、 Symbolic link):

（1）符号链接（软链接、Symbolic link)是一类特殊的文件；

（2）其包含有一条以绝对路径或者相对路径的形式指向其它文件或者目录的引用；

三、硬链接和软连接的使用

1、文件的拷贝：在硬盘中复制出来一份新的文件数据；

        window ：copy foo.js foo_copy.js

        macos ：cp foo.js foo_copy.js

2、文件的硬链接

        window ：mklink /H fh_hard.js fh.js

        macos ：ln foo.js foo hard.js

3、文件的软连接：

        window ：mklink fh_soft.js fh.js

        macos ：In -s foo.js foo_copy.js

四、pnpm做的事情

1、当使用npm或Yan时，如果有100个项目，并且所有项目都有一个相同的依赖包，那么，在硬盘上就需要保存100份该相同依赖包的副本。

2、如果是使用 pnpm，依赖包将被存放在一个统一的位置，所以：

（1）如果你对同一依赖包使用相同的版本，那么磁盘上只有这个依赖包的一份文件；

（2）如果你对同一依赖包需要使用不同的版本，则仅有版本之间不同的文件会被存储起来；

（3）所有文件都保存在硬盘上的统一的位置：

       当安装软件包时，其包含的所有文件都会硬链接到此位置，而不会占用额外的硬盘空间在项目之间可以方便地共享相同版本的依赖包

五、pnpm创建非扁平的node_modules

当使用 npm 或 Yarn Classic安装依赖包时，所有软件包都将被提升到 node_modules的 根目录下。其结果是，源码可以访问本不属于当前项目所设定的依赖包；

 

六、pnpm的安装和使用

1、安装pnpm

（1）官网提供了很多种方式来安装pnpm ：https://www.pnpm.cn/installation

（2）Node中有npm，所以我们通过npm安装即可：npm install -g pnpm

2、pnpm与npm等价命令对照表

3、更多命令和用法参考官网：https://pnpm.io/zh/

七、pnpm的存储store

1、在pnpm7.0之前，统一的存储位置是~/.pnpm-score中的；

2、在pnpm7.0之后，统一的存储位置进行了更改：<pnpm home directory>/store
（1）在Linux 上，默认是~/.local/share/pnpm/store
（2）在Windows 上：%LOCALAPPDATA%/pnpm/store
（3）在macOs 上：~/Library/pnpm/store

3、我们可以通过一些终端命令获取这个目录：

（1）获取当前活跃的store目录：

    pnpm store path

（2）另外一个非常重要的store命令是prune （修剪）：从store中删除当前未被引用的包来释放store的空间

  pnpm store prune
            

              

        







 

       

        
 















Q