简易npm包的开发流程

npm 设置

在开发一个Npm包的时候,最开始肯定是要初始化好环境:

npm set init.author.name "scq000"
npm set init.author.email "scq000@hotmail.com"
              
npm set init.author.url "https://scq000.github.io"
              
npm set init.license 'MIT'
              
cat ~/.npmrc

设置好基础的配置后,后续在开发新的项目的时候,会自动在package.json中带上预先定义的配置信息。

生成changelog

对于对外使用的npm包来说,版本更新记录是十分重要的,可以考虑使用commitzen 在每次提交代码的时候,遵循规范。

cz-conventional-changelog 是和commitizen配套使用的规则集,通常来说项目里直接使用默认配置即可:

  "config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
  },

另外,git-cz是将commitizen和git相结合的工具,根据官方文档配置后,可以直接在命令行中执行:

npx git-cz

就能实现在代码提交的时候,提供交互式的命令行来填写规范化的commit信息。

[图片上传失败...(image-825803-1650939725828)]

githook配置

githook的配置,可以限制在每次代码提交过程中,执行一些前置的代码检测、单元测试等工作。

执行如下命令:

npm install -D ghooks

然后,在项目的package.json配置文件里,配置一下钩子:

          config: {
            ghooks: {
              "pre-commit": "npm run test:single"
            }
          }

这样一来,在每次执行git commit命令之前都会执行我们预定义的脚本。

发布自动化

自动化在包的研发过程中是必不可少的,目前业界已经有较多成熟的方案。

semantic

semantic-release提供了在git上实现自动化发布的整套解决方案,可以在项目中使用如下命令行初始化:

npx semantic-release-cli setup

随后,根据提示进行输入项目信息即可

[图片上传失败...(image-5f64d-1650939725829)]

自动化测试

覆盖率及报告

对于前端代码的自动化测试,可以借助istanbul.js来实现覆盖率的统计:

在项目脚本中配置如下命令:

{
  "script": {
     "test": "nyc --reporter=html --reporter=text mocha",
     "coverage": "nyc report --reporter=text-lcov | coveralls"
  }
}

最终能够生成项目整体的测试统计报告信息。

生成github标志

https://shields.io是用来生成项目状态图标的工具,在READEME.md文件的开头贴上根据项目生成的图标,就能直接根据图标状态来观测项目构建的状态。

[![Npm Package Demo](https://img.shields.io/badge/npm%20package%20demo-publish-green)](https://scq000.github.io/xxx)[![Npm Package Demo](https://img.shields.io/badge/npm-package-demo-published-blue.svg)

[图片上传失败...(image-84a033-1650939725829)]

总结

本篇文章提供的这些流程,可以根据自身需求集成到脚手架上,从而可以在日常维护开源项目等场景中,能够高效开发。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 198,154评论 5 464
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,252评论 2 375
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 145,107评论 0 327
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,985评论 1 268
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,905评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,256评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,978评论 3 388
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,611评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,891评论 1 293
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,910评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,736评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,516评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,995评论 3 301
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,132评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,447评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,034评论 2 343
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,242评论 2 339

推荐阅读更多精彩内容