npm
npm的配置文件:package.json
- name是项目的名称;
- version是当前项目的版本号;
- description是描述信息,很多时候是作为项目的基本描述;
- author是作者相关信息(发布时用到);
- license是开源协议(发布时用到);
private属性:
private属性记录当前的项目是否是私有的,当值为true时,npm是不能发布它的,这是防止私有项目或模块发布出去的方式。
dependencies 属性:开发环境和生成环境都需要依赖的包。
devDependencies 属性:生产环境是不需要。
peerDependencies 属性:对等依赖,也就是你依赖的一个包,它必须是以另外一个宿主包为前提。ant design是依赖于react、react-dom。
版本管理
X.Y.Z
- X主版本号(major):当你做了不兼容的 API 修改(可能不兼容之前的版本);
- Y次版本号(minor):当你做了向下兼容的功能性新增(新功能增加,但是兼容之前的版本);
- Z修订号(patch):当你做了向下兼容的问题修正(没有新功能,修复了之前版本的bug)
- x.y.z:表示一个明确的版本号
- ^x.y.z:表示x是保持不变的,y和z永远安装最新的版本
- ~x.y.z:表示x和y保持不变的,z永远安装最新的版本
npm install 的原理图
npm install 检测是否有 package-lock.json 文件
没有 lock 文件
1. 分析依赖关系,这是因为我们可能包会依赖其他的包,并且多个包之间会产生相同依赖的情况
2. 从registry仓库中下载压缩包(如果我们设置了镜像,那么会从镜像服务器下载压缩包)
3. 获取到压缩包后会对压缩包进行缓存
4. 将压缩包解压到项目的node_modules文件夹中(前面我们讲过,require的查找顺序会在该包下面查找)
有 lock 文件
1. 检测 lock 中包的版本是否和 package.json 中一致(会按照semver版本规范检测);
不一致,那么会重新构建依赖关系,直接会走顶层的流程。
一致,会去优先查找缓存,没有找到,会从registry仓库下载,直接走顶层流程。查找到,会获取缓存中的压缩文件,并且将压缩文件解压到node_modules文件夹中。
yarn工具
查看 npm 镜像:npm config get registry
设置 npm 镜像:npm config set registry https://registry.npm.taobao.org
可以使用cnpm,并且将cnpm设置为淘宝的镜像
npm install -g cnpm --registry=https://registry.npm.taobao.org
npx工具
npm发布自己的包
步骤:
1. 注册npm账号: https://www.npmjs.com/
2. 在命令行登录:npm login
3. 修改package.json
4. 发布到npm registry上:npm publish
删除发布的包:npm unpublish
npm scope的作用
参考:npm scope的作用_胖鹅68的博客-CSDN博客_npm scope
- scope相当于npm包的命名空间,如果以@开头,那它就是一个scope package。
- 这样分类之后就会使结构更加清晰,比如@vue下面的包都是vue用的,相当于给包做了一个分类。
- 一个scope中可以包含很多个模块; 例如:@babel下有很多模块,方便管理
命名规则
- scope在模块name中使用时,以@开头,后边跟一个/
- package.json中,name的写法如下:“name”: “@somescope/somepackagename”
{
"name": "@jd/yujun-add",
"version": "1.0.1",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
发包流程完整举例:
项目 yujun-add
1. npm init 创建 package.json 文件
{
"name": "@jd/yujun-add",
"version": "1.0.1",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
2. 添加功能
index.js
module.exports = {
add(num1, num2) {
return num1 + num2
}
}
3. 执行 npm login
4. 执行 npm publish
5. 使用包 npm i yujun-add
const { add } = require("@jd/yujun-add")
console.log(add(111, 222))