/BuryingPoint

采用代码埋点的数据埋点工具

Primary LanguageJavaScriptMIT LicenseMIT

BuryingPoint

采用代码埋点的数据埋点工具

安装依赖模块

npm install

目录说明

  • ./lib 数据埋点工具目录
  • ./public 模版目录
  • ./server 服务端源码
  • ./src 数据埋点工具源码

脚本命令说明

package.json中已有script说明如下

开发中编译

npm run dev

启动web服务器

npm run client

开启web服务器,localhost:8000

可访问 http://loacalhost:8000/

编译

npm run build

该脚本会使用webpack检查代码并打包项目,生成的文件在./lib目录中

本地服务器

npm run server

启动node服务器,并创建SQLite3数据库

代码提交

npm run commit

该脚本会生成commit模版,避免直接使用git commit校验失败

commit message格式

Header

type:用于说明commit的类型

type 描述
feat 新功能
fix 修补bug
docs 文档
style 格式(不影响代码运行的变动)
refactor 重构(既不是新增功能,也不是修改bug的代码变动)
test 增加测试
chore 构建过程或辅助工具的变动
revert 回滚到上一个版本

注:revert比较特殊,如果当前commit用于撤销以前的commit,则必须以revert:开头,后面跟着被撤销commit的Header

scope:可以省略,用于说明commit的影响范围,比如数据层、控制层、视图层等

subject:是commit的简短描述,不超过50个字符

Body

是commit的详细描述,可省略

Footer

用于不兼容变动或关闭issue

BREAKING CHANGE:当前代码与上个版本不兼容,Footer部分以BREAKING CHANGE开头,后面是对变动的描述、变动的理由以及迁移的方法

Closes:针对某个issue,可以在Footer部分关闭这个issue,比如Closes #233