阅读 158

NodeJS小工具系列(1):创建和发布Npm模块

前言

NodeJS的同学都知道,写一个Npm模块前,要创建一堆的基础文件,如.gitignore😰、.npmignore😰、license😰、package.json😰、readme.md😰等文件。写一两个还好,手动创建后慢慢复制相关的信息到文件中去,但是有些同学比较活跃,经常为Npm社区做贡献,此时此刻这些Npm模块的基础文件创建和书写确实是挺占时间的😂。既然这些文件的内容相对比较统一,那么我们可以把它们做成模板,通过命令一键生成,那挺好的呀,哈哈😉。其实,我们开发Npm模块主要还是集中在模块功能逻辑代码上,这些附加的文件确实有点令人讨厌,但是不加又不行,对吧😬。所以,小编我就开发了个小工具pkg-master来解决上述问题,为了方便发布Npm模块,还增加了一键发布的功能,发布前会自动检测发布模块需要准备的工作,检测完后没问题就自动上传到Npm中🙏。

pkg-master

安装

npm i -g pkg-master
复制代码

使用

命令 简写 功能
pkg-master lang pkg-master l 切换语言
pkg-master new pkg-master n 创建模块
pkg-master publish pkg-master p 发布模块
  • 创建你的模块pkg-master n,提供一些问答让你自定义模块的一些基础文件
  • 进入创建好的模块cd yourModuleName,然后开发模块的功能
  • 发布开发好的模块pkg-master p,如果执行步骤出错,请根据提示修复再执行pkg-master p

语言

可使用pkg-master l来切换国际语言,目前提供以下语言

  • zh 中文
  • en 英文

细说

  • 在发布过程中,可能会提示请执行 npm config set registry https://registry.npmjs.org/ 切换回源镜像。国内大部分的开发者会因为Npm源镜像的资源下载过慢而把镜像切换成淘宝镜像🤒,而使用淘宝镜像发布Npm模块是不会成功的,需要把镜像设置回源镜像才能正常发布。
  • 在发布过程中,可能会提示请执行 npm login 登录您的Npm账号,无账号请执行 npm adduser 创建您的Npm账号。发布Npm包是需要权限的😥,执行npm login登录你的账号即可,如果是第一次发布,执行npm adduser创建账户,在登录你的账号即可。
  • 在发布过程中,可能会提示模块已存在,请使用其他名称发布模块。因为Npm模块是不允许重名的😣 ,把package.json的name属性重新起一个名字就好。
  • 发布时记得cd yourModuleName到根目录哟,不然发错了别怪我哈😛。执行npm unpublish yourModuleName@x.y.z即可撤回发布出去的Npm包,详情可自行百度。
  • 以上错误在修复后需要重新执行pkg-master p才会发布成功哟!

Publish

结语

感兴趣的小伙伴可以自行查看项目源码(亲,点击这里),喜欢的话给个Star咧😂。酝酿下准备写NodeJS小工具系列的第二篇......😋

dog

关注下面的标签,发现更多相似文章
评论