美文网首页
简易npm包的开发流程

简易npm包的开发流程

作者: SCQ000 | 来源:发表于2022-04-26 10:22 被阅读0次

    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)]

    总结

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

    相关文章

      网友评论

          本文标题:简易npm包的开发流程

          本文链接:https://www.haomeiwen.com/subject/wuycyrtx.html