npm与包

8 篇文章 0 订阅
7 篇文章 0 订阅

3.1包

node.js中的第三方模块又叫做包;
包是基于内置模块封装出来的,提供了更高级、更方便的API,极大的提高了开发效率
npm,Inc,这家公司旗下的一个网站:https://www.npmjs.com/,他是全球最大的包共享平台,你可以从这个网站上搜索到任何你需要的包。而且该公司还提供了一个地址为https://registry.npmjs.org/的服务器,来对外共享所有的包,我们可以从这个服务器上面下载自己所需要的包。

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

在这里插入图片描述

3.2 npm初体验

1.格式化时间的传统做法
1.1创建格式化时间的自定义模块;
1.2定义格式化时间的方法
1.3创建补零函数
1.4从自定义模块中导出格式化时间的函数
1.5导入格式化时间的自定义模块
1.6调用格式化时间的函数

自定义模块–07DataFormat.js

// 1.定义格式化时间的方法
function dataFormat(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 = {
    dataFormat
}

测试–07Test.js

// 1.导入时间按格式化的模块
const time = require('./07DataFormat.js');
// 调用方法,进行实践
const dt = new Date()
console.log(dt)
const newDt = time.dataFormat(dt)
console.log(newDt);

在这里插入图片描述

2.时间格式化的高级做法
21.使用npm包管理工具,在项目中安装格式化时间的包moment
2.2使用require()导入格式化的时间的包
2.3参考moment的广泛API文档对时间进行格式化

// 导入moment  模块
const moment = require('moment');
// moment()函数:获取当前时间
const data = moment().format('yyyy-MM-DD hh-mm-ss')
console.log(data)

在这里插入图片描述

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

npm install 包的完整名称

//可以简写成
npm i 包的完整名称

//默认情况下,使用上述命令安装包的时候,会自动选择安装最新版的包
//若需要安装指定版本的包,可以在包名之后,通过@符号制定具体的版本,例如:
npm i 包的完整名称@指定版本号

4.初次装包之后多了哪些文件

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

5.包的语义化版本规范
包的版本号是以“点分十进制”形式进行定义的,总共有三位数字,例如2.24.0
其中每一位数字所代表的的含义如下:
第1位数字:大版本
第2位数字:功能版本
第3位数字:Bug修复版本
版本号提升的规则:只要前面的版本号增长了,则后面的版本号归零。

3.3包管理配置文件

1.在多人协作开发时候的作用
在多人协作开发的时候,但我们用到的包有很多的时候,甚至包的大小比我们的项目的源代码的大小大得多的时候,我们还仍然共享包的话,显的就有一点点不是很聪明了,
如何记录项目中安装了哪些包
在项目根目录中,创建一个叫做package.json的配置文件,即可用来记录项目中安装了哪些包。从而方便剔除node_modules目录之后,在团队成员之间共亨项目的源代码。
注意:今后在项目开发中,一定要把node_modules文件夹,添加到.gitignore忽略文件中。

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

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

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

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

4.一次性安装所有的包
当我们拿到一个剔除了node modules 的项目之后,需要先把所有的包下载到项目中,才能将项目运行起来。
否则会报类似于下面的错误:

//由于项目运行依赖于moment这个包,如果没有提前安装好这个包,
就会报例如下面的错误:
Error: cannot find module 'moment'

如何一次性安装呢?
可以运行npm install命令(或npm i)一次性安装所有的依赖包:

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

5.卸载包
可以运行npm uninstall命令,来卸载指定的包
(npm uninstall命令执行成功之后,会把卸载的包自动从package.json 中的dependencies节点中移除)

npm uninstall 完整的包名

6.devDependencies节点
如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到devDependencies节点中。与之对应的,如果某些包在开发和项目上线之后都需要用到,则建议把这些包记录到dependencies 节点中。
您可以使用如下的命令,将包记录到devDependencies节点中:(所以但我们去下载包的时候,一般我们要想好是把它放在哪一个节点里面)

//安装指定的包,并记录到deyDependencies节点中(后面的包名和'-D'的顺序并没有严格要求的)
npm i 包名 -D
//注意:上述命令是简写形式,等价于下面完整的写法:
npm install 包名 --save-dev

3.4 解决下包速度慢的问题

1.为什么下包速度慢

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

2.淘宝NPM镜像服务器

在这里插入图片描述

淘宝在国内搭建了一个服务器,专门把国外官方服务器上的包同步到国内的服务器(每隔一段时间同步一次—将国外的服务器上面的包都同步到国内),然后在国内提供下包的服务。从而极大的提高了下包的速度。
扩展:
镜像(Mirroring)是一种文件存储形式,一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像。

3.切换npm的下包镜像源
下包的镜像源,指的就是下包的服务器地址。

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

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

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

3.5包的分类

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

1.项目包
那些被安装到项目的node_modules目录中的包,都是项目包。
项目包又分为两类,分别是:
开发依赖包(被记录到devDependencies节点中的包,只在开发期间会用到)
核心依赖包(被记录到dependencies节点中的包,在开发期间和项目上线之后都会用到)

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

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

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

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

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

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

3.6规范的包结构

在清楚了包的概念、以及如何下载和使用包之后,接下来,我们深入了解一下包的内部结构。
一个规范的包,它的组成结构,必须符合以下3点要求:
1.包必须以单独的目录而存在;
2.包的顶级目录下要必须包含package.json这个包管理配置文件;
3.package.json中必须包含name,version,main这三个属性,分别代表包的名字、版本号、包的入口。
以上的三点要求是一个规范的包结构所必须遵守的格式。

3.7开发属于自己的包

  • 1.分析并实现所需要的功能
  • 2.初始化包的基本结构
  • 3.初始化package.json文件
  • 4.在index.js中定义格式化时间的方法
  • 5.在index.js中定义转义HTML的方法
  • 6.在index.js中定义还原HTML的方法
  • 7.将不同的功能进行模块化拆分
  • 8.编写包的说明文档

详情可以点击 具体代码示例 或者点击 示例代码文件 下载相应的代码文件

3.8发布包

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

2.登录npm账号
npm账号注册完成后,可以在终端中执行npm login 命令(并不是在网站中执行命令),依次输入用户名、密码、邮箱后,即可登录成功。
注意:在运行npm login命令之前,必须先把下包的服务器地址切换为npm的官方服务器。否则会导致发布包失败!(可以先使用nrm看一下)

3.把包发布到npm官方服务器上
将终端切换到包的根目录之后,运行npm publish 命令,即可将包发布到npm上
(注意:包名不能雷同——在咱们发布之前,最好是在npm官网上面查看一下有没有相似的包名)。

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

整理不易,给个赞再走呗!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

逍遥创江湖

你的鼓励将是我创作最大的动力!

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值