这是我参与「第五届青训营 」伴学笔记创作活动的第 10 天
邂逅包管理工具
代码共享方案
- 在js中我们可以通过模块化将代码分成一个个小的结构
- 在开发中可以通过模块化的方式来封装自己的代码,并且封装成一个工具
- 可以通过导入的方式来使用,甚至可以分享给世界各地的程序员来使用
包管理工具npm
- 包管理工具npm:
- Node Package Manager,也就是Node包管理器
- 但是目前已经不仅仅是Node包管理器了,在前端项目中可以使用他来管理依赖的包
- 比如vue,express,vue-router,koa,react等
- npm管理的包可以在哪里查看、搜索呢?
https://www.npmjs.org/
- npm管理的包存放在哪里呢?
- 我们发布自己的包其实是发布到registry上面的;
- 当我们安装一个包时其实是从registry上面下载的包;
npm配置文件
-
如何使用npm来管理这么多包?
- 每个项目都会有一个对应的配置文件,无论是前端项目(Vue、React)还是后端项目;
- 这个配置文件记录项目的名称、版本号、项目描述等;
- 也会记录项目所依赖的其他库的信息和版本号;
-
这个配置文件就是package.json
-
如何获取配置文件?
- 1.手动从零创建项目,npm init -y
- 2.通过脚手架,脚手架会生成package.json,并且里面会有相关的配置
常见属性
-
必须项:name、version
- name是项目的名称;
- version是当前项目的版本号;
- description是描述信息,很多时候是作为项目的基本描述
- author是作者相关信息
- license是开源协议
-
private属性:
- private属性记录当前的项目是否是私有的
- 当值为true时,npm是不能发布它的,这是防止私有项目或模块发不出去的方式
-
main属性:
- 设置程序的入口
- 比如axios模块 const axios = require('axios');
- 如果有main属性,实际上是找到对应的main属性查找文件的;
- 设置程序的入口
-
scripts属性
- 用于配置一些脚本命令,以键值对的形式存在
- 配置后可以用npm run 命令key来执行这个命令;
- npm start和npm run start 的区别
- 他们是等价的
- 对用常用的start、test、stop、restart可以省略掉run直接通过npm start等方式运行
-
dependencies属性
- dependencies属性是指无论开发环境还是生成环境都需要依赖的包
- 通常是我们项目实际开发用到的一些库模块vue、vuex、vue-router、react、react-dom、axios等等;
-
devDepnedencies属性
- 一些包在生成环境是不需要的,比如webpack、babel等;
- 这个时候要通过npm install webpack --save-dev,将它安装到devDependencies属性中;
-
peerDependencies属性
- 还有一种项目依赖关系是对等关系,也就是你依赖一个包,她必须是以另外一个宿主包为前提;
- 比如element-plus是依赖于vue3的,ant-design是依赖于react,react-dom;
-
依赖的版本管理
-
安装的依赖版本出现:^2.0.3或~2.0.3,这是什么意思呢
-
npm的包通常需要遵从semver版本规范:
- semver:
https://semver.org/lang/zh-CN/ - npm semver:
https://docs.npmjs.com/misc/semver
- semver:
-
semver版本规范是X.Y.Z:
- X主版本号(major):做了不兼容的 API 修改(可能不兼容之前的版本);
- X主版本号(major):做了不兼容的 API 修改(可能不兼容之前的版本);
- Z修订号(patch):做了向下兼容的问题修正(没有新功能,修复了之前版本的bug);
-
x.y.z:表示一个明确的版本号;
-
^x.y.z:表示x是保持不变的,y和z永远安装最新的版本;
-
~x.y.z:表示x和y保持不变的,z永远安装最新的版本;
-
engines属性
- engines属性用于指定Node和NPM的版本号;
- 在安装的过程中,会先检查对应的引擎版本,如果不符合就会报错;
- 事实上也可以指定所在的操作系统 "os" : [ "darwin", "linux" ],只是很少用到;
-
browserslist属性
- 用于配置打包后的JavaScript浏览器的兼容情况,参考
- 否则需要手动的添加polyfills来让支持某些语法
- 也就是说它是为webpack等打包工具服务的一个属性
npm install 命令
-
安装npm包分两种情况:
- 全局安装(global install):npm install webpack -g;
- 项目(局部)安装(local install):npm install webpack;
-
全局安装
- 全局安装是直接将莫格包安装到全局
- 比如全局安装yarn:
- npm install yarn -g
-
通常使用npm全局安装的包都是一些工具包:yarn,webpack等;
-
并不是类似于axios express koa等库文件;
-
所以全局安装了之后并不能让我们在所有的项目中使用axios
-
局部安装分为开发时依赖和生产时依赖:
# 默认安装开发和生产依赖
npm install axios
npm i axios
# 开发依赖
npm install webpack --save-dev
npm install webpack -D
npm i webpack –D
# 根据package.json中的依赖包
npm install
npm install 原理
npm install <package>,它的内部原理- 执行 npm install它背后帮助我们完成了什么操作?
- 我们会发现还有一个称之为package-lock.json的文件,它的作用是什么?
- 从npm5开始,npm支持缓存策略(来自yarn的压力),缓存有什么作用呢?
-
npm install会检测是有package-lock.json文件:
- 没有lock文件
- 分析依赖关系,这是因为我们可能包会依赖其他的包,并且多个包之间会产生相同依赖的情况;
- 从registry仓库中下载压缩包(如果我们设置了镜像,那么会从镜像服务器下载压缩包);
- 获取到压缩包后会对压缩包进行缓存(从npm5开始有的);
- 将压缩包解压到项目的node_modules文件夹中(前面我们讲过,require的查找顺序会在该包下面查找)
- 有lock文件
- 检测lock中包的版本是否和package.json中一致(会按照semver版本规范检测);
- 不一致,那么会重新构建依赖关系,直接会走顶层的流程;
- 一致的情况下,会去优先查找缓存
- 没有找到,会从registry仓库下载,直接走顶层流程;
- 查找到,会获取缓存中的压缩文件,并且将压缩文件解压到node_modules文件夹中;
- 没有lock文件
-
package-lock.json文件解析:
- name:项目的名称;
- version:项目的版本;
- lockfileVersion:lock文件的版本;
- requires:使用requires来跟踪模块的依赖关系;
- dependencies:项目的依赖
- 当前项目依赖axios,但是axios依赖follow-redireacts;
- axios中的属性如下:
- version表示实际安装的axios的版本;
- resolved用来记录下载的地址,registry仓库中的位置;
- requires/dependencies记录当前模块的依赖;
- integrity用来从缓存中获取索引,再通过索引去获取压缩包文件;
npm其他命令
- 卸载某个依赖包:
npm uninstall package
npm uninstall package --save-dev
npm uninstall package -D
- 强制重新build
npm rebuild
- 清除缓存
npm cache clean
- npm的命令其实是非常多的:
- docs.npmjs.com/cli-documen…
- 更多的命令,可以根据需要查阅官方文档
npm发布自己的包
- 注册npm账号:
- www.npmjs.com/
- 选择sign up
- 在命令行登录:
- npm login
- 修改package.json
- 发布到npm registry上
- npm publish
- 更新仓库:
- 1.修改版本号(最好符合semver规范)
- 2.重新发布
- 删除发布的包:
- npm unpublish
- 让发布的包过期:
- npm deprecate