【Node.js】包与npm包

目录

1. 包与npm包的概念

1.1 包的概念

1.2 包的下载途径

2. 使用npm包

2.1 使用npm包示例

2.2 初次安装包产生的文件

2.3 安装指定版本的包

2.4 包管理配置文件

3.  包镜像服务器

3.1 包镜像管理工具

4. 包的分类

5. 发布包

5.1 初始化包的基本结构

5.2 README.md 文件 

5.3 发布包到npm

---

1. 包与npm包的概念

1.1 包的概念

Node.js第三方的模块称为包。包上基于内置模块封装出来的，提供了更方便的API，提高了开发效率。

1.2 包的下载途径

npm Inc是全球最大的包共享平台。

1. 可以从https://www.npmjs.com搜索需要的包。

2. npm包管理工具，使用npm -v可查看包管理工具。使用npm install  xxx下载需要的包

2. 使用npm包

2.1 使用npm包示例

使用npm第三方的包进行时间格式化，安装moment包，使用format方法：

1. 安装moment包

由于没有安装镜像，包下载太慢，提示了idealTree:leetcode: sill idealTree buildDeps，

这边安装了淘宝镜像，再安装需要的包就很快了

// 安装镜像
npm config set registry https://registry.npm.taobao.org 
 
// 查看是否安装成功
npm config get registry 

附：淘宝镜像服务的原理  

2.2 初次安装包产生的文件

初次安装包完成后，在项目文件夹下多一个叫做node_modules的文件夹和package-lock.json的配置文件以及package.json配置文件。

node_modules文件夹：用来存放所有已经安装到项目中的包。require()导入第三方包时，就是从这个目录中查找并加载包的。

package-lock.json配置文件：用来记录node_modules目录下的每一个包的下载信息，例如包的名字，版本号，下载地址等。

注意：不要手动修改node_modules或配置文件的代码，npm包管理工具会自动维护它们。 

 

2.3 安装指定版本的包

 1. 安装指定包

命令：@后面指定安装包的版本号

npm install xxx@xx.xx.xx

 2. 包的语义化版本规范

包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如2.24.0

其中每一位数字代表的含义如下：

第一位数字：大版本

第二位数字：功能版本

第三位数字：Bug修复版本

版本号提升的规则：只要前面的版本号增长了，则后面的版本号归零。

 2.4 包管理配置文件

 1. 包管理配置文件

 2. 快速创建包管理配置文件

npm包管理工具提供了一个快捷命令，可以在执行命令时所处的目录中，快速创建package.json这个包管理配置文件：

npm init -y

 一次性安装所有依赖包：

npm install

执行npm install 命令时，npm包管理工具会先读取package.json中的depandencies节点，读取到记录的所有依赖包名称和版本号后，npm包管理工具会把这些包一次性下载到项目中。 

 卸载包：

npm uninstall xxx

package.json配置文件和package-lock.json配置文件会把包信息自动删除。

3. devDependencis节点

如果某些包只在项目开发阶段用到，在项目上线之后不会用到，则建议把这些包记录到devDependencies节点中。与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到dependencies节点中。

命令：

// 简写命令
npm i xxx -D
 
//完整命令
npm i xxx --save-dev

3.  包镜像服务器

3.1 包镜像管理工具

1. 安装镜像命令

2. nrm镜像切换工具 

4. 包的分类

1. 

 2. 全局包

 3. i5ting_toc

 4. 规范的包结构 

5. 发布包

5.1 初始化包的基本结构

1. 新建mypkg-tools文件夹，作为包的根目录，在中mypkg-tools文件夹中，新建如下三个文件：

• package.json(包管理配置文件)
• index.js（包的入口文件）
• README.md(包的说明文档)

 2. 在index.js定义格式化时间的方法，然后导出方法，然后在test.js文件尝试引入自定义包，并且使用对应方法：

 5.2 README.md 文件 

包根目录中但README.md文件，是包的使用说明文档，通过它，我们可以事先把包的使用说明，以markdown的格式写出来，方面用户参考。 

 5.3 发布包到npm

1. 在npm官网注册账号

2. 登陆npm账号

在npm官方镜像中，输入node login，会提示输入用户名、密码、邮箱

nrm use npm
 
npm login
 

3. 发布包到npm上

包名必须唯一，不能与npm中的其他包同名。在自定义的包目录下，执行发包命令：

npm pulish

4. 删除包

执行删除包命令，xxx是包名

npm unpublish xxx --force