Node.JS - npm与包 - 《代码知识》

包
npm初体验
包管理配置文件
解决下包速度慢的问题
包的分类
开发属于自己的包
导入
格式化时间
转义惠特html中的特殊字符
开源协议
- 发布包

包

什么是包

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/的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

如何下载包

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

npm初体验

格式化时间的传统做法

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

function dateFormat(dtStr){
    const  dt = new Date(dtStr)
    const y = dt.getFullYear()
    const m = padZero(dt.getMonth()+1)
    const d = padZero(dt.getDate())
    const hh =padZero(dt.getHours())
    const mm = padZero(dt.getMinutes())
    const ss =padZero(dt.getSeconds())
    return y+'-'+m+'-'+d+'-'+' '+hh+':'+mm+':'+ss
}
function padZero(n){
    return  n>9 ?n:'0'+n
}
module.exports={
    dateFormat
}

const  Time = require('dateFormat')
//调用方法,进行事件的格式化
const dt=new Date()
const newDT = Time.dateFormat(dt)
console.log(newDT)

格式化时间的高级做法

①使用npm包管理工具，在项目中安装格式化时间的包moment

const moment = require('moment')
const dt = moment().format('YYYY-MM-DD HH:mm:ss')
console.log(dt)

初次装包后多了哪些文件

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

安装指定版本的包

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

包的语义化版本规范

包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如2.24.0
第1位数字：大版本
第2位数字：功能版本
第3位数字：Bug修复版本
版本号提升的规则：只要前面的版本号增长了，则后面的版本号归零。

包管理配置文件

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

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

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

快速创建package.json

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

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

devDependencies 节点

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

解决下包速度慢的问题

为什么下包速度慢

在使用npm下包的时候，默认从国外的https://registry.npmjs.org/服务器进行下载，此时，网络数据的传输需要经过漫长的海底光缆，因此下包速度会很慢。

切换npm的下包镜像源

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

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

nrm

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

包的分类

项目包

那些被安装到项目的node_modules 目录中的包，都是项目包。
项目包又分为两类，分别是：

开发依赖包（被记录到devDependencies节点中的包，只在开发期间会用到）
核心依赖包（被记录到dependencies节点中的包，在开发期间和项目上线之后都会用到）
全局包
在执行npm install 命令时，如果提供了-g参数，则会把包安装为全局包。

①只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
②判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。
i5ting toc
iSting_toc是一个可以把md文档转为html页面的小工具，使用步骤如下：

规范的包结构
在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。
一个规范的包，它的组成结构，必须符合以下3点要求：
①包必须以单独的目录而存在
②包的顶级目录下要必须包含package.json这个包管理配置文件
③ package.json中须包含 name，version，main这三个属性，分别代表包的名字、版本号、包的入口。
开发属于自己的包
需要实现的功能
①格式化日期
②转义HTML中的特殊字符
③还原HTML中的特殊字符

初始化包的基本结构
①新建itheima-tools文件夹，作为包的根目录
②在itheima-tools文件夹中，新建如下三个文件：
package.json（包管理配置文件）
index.js（包的入口文件）
README.md（包的说明文） ```javascript //这个是包的入口文件 const {match} = require(“yarm/lib/mongoose/query”);

function dataFormat(dataStr) { const dt =new Date(dataStr) const y = dt.getFullYear() const m = padZero(dt.getMonth()+1) const d = padZero(dt.getDate())

const hh =padZero(dt.getHours())
const mm = padZero(dt.getMinutes())
const ss =padZero(dt.getSeconds())
return `${y}-${m}-${d} ${hh}:${mm}:${ss}`

}

function padZero(n){ return n>9 ?n:’0’+n }

function htmlEscape(htmlStr){ return htmlStr.replace(/<|>|”|&/g,(match)=>{ switch (match){ case ‘<’: return ‘<’ case ‘>’: return ‘>’ case ‘“‘: return ‘"’ case ‘&’: return ‘&’ } }) }

function htmlUnEscape(htmlStr){ return htmlStr.replace(/<|>|"|&/g,(match)=>{ switch (match){ case ‘<’: return ‘<’ case ‘>’: return ‘>’ case ‘"’: return ‘“‘ case ‘&’: return ‘&’ } }) } module.exports={ dataFormat, htmlEscape, htmlUnEscape }

```javascript
const it= require('./itheima-tools')
const dt = new Date()
const dtStr= it.dataFormat(dt)
const htmlStr= '<h1 title="abc"> 这个是h1标签<span>123&nbsp;</span></h1>'
const str= it.htmlEscape(htmlStr)
const unstr= it.htmlUnEscape(str)
console.log(dtStr)
console.log(str)
console.log(unstr)

将不同的功能进行模块化拆分

①将格式化时间的功能，拆分到src->dateFormat.js中
②将处理HTML字符串的功能，拆分到src->htmlEscape.js中
③在index.js中，导入两个模块，得到需要向外共享的方法
④在index.js 中，使用module.exports把对应的方法共享出去
在创建src文件夹,并创建文件

//这个是包的入口文件
const {match} = require("yarm/lib/mongoose/query");
function dataFormat(dataStr) {
    const dt =new Date(dataStr)
    const y = dt.getFullYear()
    const m = padZero(dt.getMonth()+1)
    const d = padZero(dt.getDate())
    const hh =padZero(dt.getHours())
    const mm = padZero(dt.getMinutes())
    const ss =padZero(dt.getSeconds())
    return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}
function padZero(n){
    return  n>9 ?n:'0'+n
}
module.exports={
    dataFormat
}

function htmlEscape(htmlStr){
    return htmlStr.replace(/<|>|"|&/g,(match)=>{
        switch (match){
            case '<':
                return '&lt;'
            case '>':
                return '&gt;'
            case '"':
                return '&quot;'
            case '&':
                return  '&amp;'
        }
    })
}
function htmlUnEscape(htmlStr){
    return htmlStr.replace(/&lt;|&gt;|&quot;|&amp;/g,(match)=>{
        switch (match){
            case '&lt;':
                return '<'
            case '&gt;':
                return '>'
            case '&quot;':
                return '"'
            case '&amp;':
                return  '&'
        }
    })
}
module.exports={
    htmlUnEscape,
    htmlEscape
}

在上级目录创建index.js文件并写入package.json文件

const date= require('./src/dateFormat')
const escape= require('./src/htmlEscape')
module.exports={
    ...date,
    ...escape
}

{
  "name": "itheima-tools",
  "version": "1.0.0",
  "main": "index.js",
  "description": "提供了格式化事件,HEMLEScape的功能",
  "keywords": ["itheima","dateFormat","escape"],
  "license": "ISC ",
  "dependencies": {
  }
}

编写包的说明文档

包根目录中的README.md文件，是包的使用说明文档。通过它，我们可以事先把包的使用说明，以markdown的格式写出来，方便用户参考。
README文件中具体写什么内容，没有强制性的要求；只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。
我们所创建的这个包的README.md文档中，会包含以下6项内容：安装方式、导入方式、格式化时间、转义HTML中的特殊字符、还原HTML中的特殊字符、开源协议

## 安装
```angular2html
npm install itheima-tools -g

导入

const it= require('./itheima-tools')

格式化时间

const dtStr= it.dataFormat(new Date())
console.log(dtStr)
//结果 2022-04-25 22:26:20

转义惠特html中的特殊字符

const htmlStr= '<h1 title="abc"> 这个是h1标签<span>123&nbsp;</span></h1>'
const str= it.htmlEscape(htmlStr)
console.log(str)

开源协议

ISC ```

发布包

注册npm账号

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

登录npm账号

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

注意：在运行npm login命令之前，必须先把下包的服务器地址切换为npm的官方服务器。否则会导致发布包失败！

删除已发布的包

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

npm与包

包