@helper-gdp/utils v1.5.0

helper-gdp-utils

gdp小组工具库

使用文档

Getting Started

更新记录

Getting History

提交规范

• 新增的内容在test对应路径下需要有指定的test文件
• 新增的内容单元测试尽量做到100%覆盖
• 新增的内容在doc文档内应有详细的说明
• 每一版的发布都应生成完成的测试覆盖报告

发布npm库

1. 确认当前npm源正确https://registry.npmjs.org/
2. 确认登录该源的账号正确,并具备发布库的权限
3. yarn run build及yarn run docs 打包生产代码及组件文档
4. 执行git add -A及yarn run commit提交更改
5. 发布命令为yarn run release -- --release-as [major/minor/patch] 根据更新程度决定采用的的release as值, 如果为内测或公测版本则补充prerelease参数 yarn run release -- --release-as [major/minor/patch] --prerelease [alpha/beta]
6. git push --follow-tags origin dev 推送到远程分支
7. yarn publish正式发布 or yarn publish --tag [alpha/beta]内测或公测发布
8. 切换至master, git merge dev 拉取更改
9. git push origin master 更新远程仓库

cli 命令

• yarn run clean移除build文件目录
• yarn run test进行单元测试
• yarn run docs生成使用文档 HTML
• yarn run build执行打包构建
• yarn run dev执行打包构建并监听后需改动,同步build
• yarn run commit代码commit
• yarn run release发布release changelog

TODO

• 为指定md文件生成目录: doctoc [filename]