2022-07-26 14:16:37

npm包从创建到发布

背景

在工作中我们积累了一些自己的功能代码。这些功能代码可以在其它项目中重复使用，此时我们就可以选择把代码打包放在[npm]上,在需要要使用的项目中，通过npm install去下载下来。

npm项目初始化

在本地磁盘上创建一个空项目，取文件夹名为myNpm。注意请先去npm网官去确定一下，这个项目名是否已经被占用了。（如果这个名字已经被占用了，则你是无法向npm上上传的）。

检查方式

npm view 包名
# 这个命令用来查看 某个包的信息
# 如果返回404，说明这个项目名在npm官网上找不到，此时你就可以使用。
# 否则，说明不可用。

很确定地告诉你，myNpm这个包已经被别人占用了，你需要去自己用另一个名字。

npm init--yes

命令来创建一个package.json文件，对你项目myNpm信息进行设置。

完成功能开发

正常开发，完成你的代码。在默认情况下，index.js是这个项目的入口文件。

下面是一个最简单的示例：

//tools.jsconstrelativeTime=(oldTime)=>{const t=newDate(oldTime)// Date.now()：现在的时间戳（毫秒）// t.getTime()：旧时间的时间戳（毫秒）const diff= Date.now()- t.getTime()// 相隔多少毫秒// Math.floor 向下取整： 1.7年 ---> 1年前const year= Math.floor(diff/(1000*3600*24*365))if(year){return`${year}年前`}const month= Math.floor(diff/(1000*3600*24*30))if(month){return`${month}月前`}const day= Math.floor(diff/(1000*3600*24))if(day){return`${day}天前`}const hour= Math.floor(diff/(1000*3600))if(hour){return`${hour}小时前`}const minute= Math.floor(diff/(1000*60))if(minute){return`${minute}分钟前`}else{return'刚刚'}}constformatDate=(dateTime)=>{// console.log(date)// date = new Date();const date=newDate(dateTime)// 转换成Data();
  console.log(date)var y= date.getFullYear()
  console.log(y)var m= date.getMonth()+1
  m= m<10?'0'+ m: mvar d= date.getDate()
  d= d<10?('0'+ d): dreturn y+'-'+ m+'-'+ d}// 通过module.exports来导出模块
module.exports={
  formatDate,
  relativeTime};

切换当前`npm源`到官网

由于我们需要把包上传到npm上，所以要先确保当前的npm源是npmjs.org。与之相关的命令有如下两条。

（1）查看当前的npm的registry配置.

npm configget registry 
# 查看当前的npm的registry配置，确保是https://registry.npmjs.org

# 如果不是，可以通过如下命令来设置
npm configset registry https://registry.npmjs.org 
# 手动设置registry

（2）或者使用nrm工具来设置：
在这里插入图片描述

连接npm`npm adduser`

这个命令需要输入三个信息以供连接上npmjs：

- 用户名- 密码- 邮箱（是你在npmjs官网上注册时使用的信息）

在这里插入图片描述

如果你已经不是第一次连接了，这一步是可以省略的。

你也可以通过如下命令检查自己是否连接成功了。

npm who am i

如果成功了，则可以进行最后一步了：`publish`

如果想退出:

npm logout

把包上传到npm

 npm publish

如果成功：

-----------------------------------
npm notice
npm noticepackage: tool61@1.0.0
npm notice=== Tarball Contents===
npm notice1.3kB index.js
npm notice220Bpackage.json
npm notice=== Tarball Details===
npm notice name:          tool61
npm notice version:1.0.0
npm noticepackage size:855B
npm notice unpacked size:1.5 kB
npm notice shasum:3bfba7bc92e242810a850ac39ded7ebe992a6d9c
npm notice integrity:     sha512-VoRuxxbcGzXen[...]v3tKWYUT1B1AQ==
npm notice total files:2
npm notice+ tool61@1.0.0

出错的可能是：

这个包名被别人先用了。
包的版本号不对：每次publish时，包的版本号都应该要大于之前的版本号。
文件过大。你可能需要创建.npmignore文件来设置在打包时要忽略哪些文件。如下是一个demo.

#.npmignore/node_modules
npm-debug.log/src/examples/build

如果没有报错，则表示一切ok，你可以用你的帐号密码登陆npm，去查看你名下的package是否有了myNpm

下载使用

通过npm install 包名即可来安装包。然后，告诉你的小伙伴们去下载使用吧。

更新包

修改代码，保存。
更新版本号。可直接在package.json中修改：只能改大，不能改小。
重新publish

删除包

npm unpublish--force//强制删除

如果你的包没有什么用处，建议删除掉，以节约公共资源。