npm与包的简单概念

包

• 包的概念：Node.js 中的第三方模块又叫做包。
• 包的来源：不同于 Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。注意：Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用。
• 为什么需要包：由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发的时，效率很低。
  包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。
  包和内置模块之间的关系，类似于 jQuery 和 浏览器内置 API 之间的关系
• 从哪里下载包：国外有一家 IT 公司，叫做 npm, Inc. 这家公司旗下有一个非常著名的网站： https://www.npmjs.com/ ，它是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包，只要你有足够的耐心！
  到目前位置，全球约 1100 多万的开发人员，通过这个包共享平台，开发并共享了超过 120 多万个包 供我们使用。
  npm, Inc. 公司提供了一个地址为 https://registry.npmjs.org/ 的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

注意：
从 https://www.npmjs.com/ 网站上搜索自己所需要的包
从 https://registry.npmjs.org/ 服务器上下载自己需要的包

• 如何下载包：npm, Inc. 公司提供了一个包管理工具，我们可以使用这个包管理工具，从 https://registry.npmjs.org/ 服务器把需要的包下载到本地使用。
  这个包管理工具的名字叫做 Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。

npm 的使用

• 格式化时间的传统做法

创建格式化时间的自定义模块
定义格式化时间的方法
创建补零函数
从自定义模块中导出格式化时间的函数
导入格式化时间的自定义模块
调用格式化时间的函数

• 格式化时间的高级做法

使用 npm 包管理工具，在项目中安装格式化时间的包 moment
使用 require() 导入格式化时间的包
参考 moment 的官方 API 文档对时间进行格式化

在项目中安装包的命令

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

npm install 包的完整名称
//简写格式
npm i 包的完整名称

初次装包后多了哪些文件

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

• node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时，就是从这个目录中查找并加载包。
• package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。
  注意：程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码，npm 包管理工具会自动维护它们。

  安装指定版本的包

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

  npm i moment@2.22.2

  包管理配置文件

  npm 规定，在项目根目录中，必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息。例如：
• 项目的名称、版本号、描述等
• 项目中都用到了哪些包
• 哪些包只在开发期间会用到
• 那些包在开发和部署时都需要用到

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

在项目根目录中，创建一个叫做 package.json 的配置文件，即可用来记录项目中安装了哪些包。从而方便剔除 node_modules 目录之后，在团队成员之间共享项目的源代码。

注意：今后在项目开发中，一定要把 node_modules 文件夹，添加到 .gitignore 忽略文件中。

快速创建 package.json

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

npm init -y

注意:

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

一次性安装所有的包

当我们拿到一个剔除了 node_modules 的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来
可以运行 npm install 命令（或 npm i）一次性安装所有的依赖包

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

卸载包

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

npm uninstall 包的完整名称

节点

1. dependencies 节点
   package.json 文件中，有一个 dependencies 节点，专门用来记录您使用 npm install 命令安装了哪些包。
2. devDependencies 节点
   如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies 节点中。与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies 节点中。
   您可以使用如下的命令，将包记录到 devDependencies 节点中

   npm install 包名 --save-dev   //完整写法
   npm i 包名 -D     //简写

   切换 npm 的下包镜像源

   下包的镜像源，指的就是下包的服务器地址

   //查看当前的下包镜像源
   npm config get registry
   //将下包的镜像源切换为淘宝镜像源
   npm config set registry=https ://registry .npm. taobao .org/
   //检查镜像源是否下载成功
   npm config get registry

   nrm

   为了更方便的切换下包的镜像源，我们可以安装 nrm 这个小工具，利用 nrm 提供的终端命令，可以快速查看和切换下包的镜像源。

   //通过npm包管理器，将nrm安装为全局可用的工具
   npm i nrm -g
   //查看所有可用的镜像源
   nrm ls
   //将下包的镜像源切换为taobao 镜像
   nrm use taobao

   包的分类

   分为项目包和全局包

   项目包

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

项目包又分为两类，分别是：

• 开发依赖包（被记录到 devDependencies 节点中的包，只在开发期间会用到）
• 核心依赖包（被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到）

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

全局包

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

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

注意：

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

i5ting_toc

i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具，使用步骤如下：

//将i5ting toc安装为全局包
npm install -g i5ting_toc
//调用i5ting toc,轻松实现md转html的功能
i5ting_toc -f 要转换的md文件路径 -o

规范的包结构

在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。
一个规范的包，它的组成结构，必须符合以下 3 点要求：

• 包必须以单独的目录而存在
• 包的顶级目录下要必须包含 package.json 这个包管理配置文件
• package.json 中必须包含 name，version，main 这三个属性，分别代表包的名字、版本号、包的入口。
  注意：以上 3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址：
  https://yarnpkg.com/zh-Hans/docs/package-json

发布包

1. 注册npm 账号
2. 登录npm 账号
   npm 账号注册完成后，可以在终端中执行 npm login 命令，依次输入用户名、密码、邮箱后，即可登录成功
   注意：在运行 npm login 命令之前，必须先把下包的服务器地址切换为 npm 的官方服务器。否则会导致发布包失败！
3. 把包发布到npm上
   将终端切换到包的根目录之后，运行 npm publish 命令，即可将包发布到 npm 上（注意：包名不能雷同）
4. 删除已发布的包

运行 npm unpublish 包名 –force 命令，即可从 npm 删除已发布的包。注意：

• npm unpublish 命令只能删除 72 小时以内发布的包
• npm unpublish 删除的包，在 24 小时内不允许重复发布
• 发布包的时候要慎重，尽量不要往 npm 上发布没有意义的包！