手把手教你发表一个包

简单了解一下包

1. 什么是包?

Node.js 中的第三方模块又叫做包。
就像电脑和计算机指的是相同的东西，第三方模块和包指的是同一个概念，只不过叫法不同。

2. 包的来源

不同于 Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。

3. 为什么需要包

由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发的时候，效率很低。
包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。
包和内置模块之间的关系，类似于 jQuery 和浏览器内置 API 之间的联系。

4. 从哪里下载包

国外有一家 IT 公司，叫做 npm，lnc. 这家公司旗下有一个非常著名的网站：https://www.npmjs.com/，它是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包，只要你有足够的耐心。
npm,lnc.公司提供了一个地址为 https://registry.npmjs.org/ 的服务器，对来外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

5. 如何下载包

npm, Inc. 公司提供了一个包管理工具，我们可以使用这个包管理工具，从 https://registry.npmjs.org/ 服务器把需要的包下载到本地使用。
这个包管理工具的名字叫做 Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。
大家可以在终端中执行 npm -v 命令，来查看自己电脑上所安装的npm 包管理工具的版本号：

6. 包的分类

使用 npm 包管理工具下载的包，共分为两大类，分别是：
● 项目包
● 全局包

1. 项目包

那些被安装到项目的 node_modules 目录中的包，都是项目包。

项目包又分为两类，分别是：
● 开发依赖包（被记录到 devDependencies 节点中的包，只在开发期间会用到）
● 核心依赖包（被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到）

1 npm i 包名 -D   # 开发依赖包(会被记录到 devDependencies 节点下)
2 npm i 包名      # 核心依赖包(会被记录到 dependencies 节点下)

2. 全局包

在执行 npm install 命令时，如果提供了 -g 参数，则会把包安装为全局包。
全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下。

1 npm i 包名 -g            # 全局安装指定的包
2 npm uninstall 包名 -g    # 卸载全局安装的包

注意:
① 只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
② 判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。

7. 安装包

1. 在项目中安装包的命令

如果想在项目中安装指定名称的包，需要运行如下的命令：

  npm install 包的完整名称

上述的装包命令，可以简写成如下格式：

  npm i 完整的包名称

一次性安装所有的包

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

2. 初次装包之后多的文件

初次装包完成之后，在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件
其中：
node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时，就是从这个目录中查找并加载包。
package-lock.json配置文件用来记录 node_modules 目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。

3. 安装指定版本的包

默认情况下，使用npm install 命令安装包的时候，会自动安装最新版本的包。如果需要安装指定版本的包，可以在包名之后，通过@ 符号指定具体的版本，例如：

  npm i moment@1.11.1

4. 如何记录项目中安装了哪些包

在项目根目录中，创建一个叫做 package.json 的配置文件，即可用来记录项目中安装了哪些包。从而方便剔除 node_modules 目录之后，在团队成员之间共享项目的源代码。
注意：今后在项目开发中，一定要把 node_modules 文件夹，添加到 .gitignore 忽略文件中。

5. 快速创建 package.json

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

1  // 作用：在执行命令所处的目录中，快速新建 package.json 文件
2  npm init -y

注意：
①上述命令只能在英文的目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。
②运行 npminstall 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中。

6. dependencies节点

package.json 文件中，有一个 dependencies 节点，专门用来记录您使用 npm install 命令安装了哪些包。

7. devDependencies节点

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

可以使用如下的命令，将包记录到 devDependencies 节点中：

1 // 安装指定的包，并记录到 devDependencies 节点中
2 npm i 包名 -D
3 // 注意：上述命令是简写形式，等价于下面完整的写法：
4 npm install 包名 --save-dev 

8. 卸载包

可以运行 npm uninstall 命令，来卸载指定的包：

1 // 使用 npm uninstall 具体的包名，来卸载包
2 npm uninstall moment

注意：npm uninstall 命令执行成功后，会把卸载的包，自动从package.json 的dependencies 中移除掉。

8. 规范的包结构

在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。

一个规范的包，它的组成结构，必须符合以下3 点要求：

① 包必须以单独的目录而存在
② 包的顶级目录下要必须包含 package.json 这个包管理配置文件
③ package.json 中必须包含 name，version，main 这三个属性，分别代表包的名字、版本号、包的入口。


注意：以上3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址：

https://yarnpkg.com/zh-Hans/docs/package-json

9. 发布包

1. 注册 npm 账号

① 访问 https://www.npmjs.com/ 网站，点击 sign up 按钮，进入注册用户页面
② 填写账号相关的信息：full Name、Public Email、Username、Password
③ 点击 Create an Account 按钮，注册账号
④ 登录邮箱，点击验证链接，进行账号的验证

2. 登录 npm 账号

npm 账号注册完成后，可以在终端中执行 npm login 命令，依次输入用户名、密码、邮箱后，即可登陆成功。

3. 把包发布到 npm 上

将终端切换到包的根目录之后，运行 npm publish 命令，即可将包发布到npm 上（注意：包名不能雷同）。

4. 删除已发布的包

运行 npm unpublish 包名 --force 命令，即可从 npm 删除已发布的包。
注意：
① npm unpublish 命令只能删除72 小时以内发布的包
② npm unpublish 删除的包，在24 小时内不允许重复发布
③ 发布包的时候要慎重，尽量不要往npm 上发布没有意义的包！