@tuia/log-hub

推啊埋点sdk

Usage no npm install needed!

<script type="module">
  import tuiaLogHub from 'https://cdn.skypack.dev/@tuia/log-hub';
</script>

README

推啊埋点 SDK

推啊前端埋点方案

npm 主页地址

开发

如果已经打包过就直接运行如下命令，开启监听，文件改动会同步打包到 lib 下

yarn watch
# Or 
npm run watch

src/index.ts 是入口文件，方法挂载 更改文件之后，在本地调试的时候运行如下命令，把包链接到本地

yarn link
# Or 
npm link

出现如下提示

You can now run yarn link "@tuia/log-sdk" in the projects where you want to use this package and it will be used instead.

然后在需要调试的项目中（其他使用这个包的项目）yarn link "@tuia/log-sdk" 把本地的包链接到改项目进行调试

打包

打包生产环境sdk (压缩后)

yarn build
# Or 
npm run build

打包开发环境 (压缩前)方便调试

yarn dev
# Or 
npm run dev

发布前准备工作

  1. 首先确保已经登录 npm 账号并且拥有发布权限
  2. 生成版本号、打tag和生成更改日志，其他用法详情见standard-version
  1. 指定版本号，如0.1.0-beta
yarn release -- --release-as <版本号>
# Or 
npm run release -- --release-as <版本号>
  1. 不指定版本号，直接自动累加
yarn release
# Or 
npm run release

成功之后把 tag 推到远程

git push --follow-tags origin master

发布到 npm 和 cdn (谨慎)

发布说明（⚠️）

  1. 🚀 统一在 master 发布！！！
  2. ✅ 发布前检查，打包发布前必须要有 master 分支的最新内容！！！

发布三步：分布命令

  1. 发布版本前 npm run release 会自动累加版本号 + 打 tag + 生成更改日志，不想累加想自定义版本号则 npm run release -- --release-as <版本号>
  2. 然后 npm run build && npm publish --access public 发布 npm 和 npm run pub 发布cdn
  3. 最后把本地tag推到远程 eg: git push --follow-tags

组合命令：直接 npm run deploy 发布，结合了上述所有命令

🚨 注意：请勿用 yarn deploy 代替 npm run deploy，必须要用npm，因为包含npm的登陆发布操作

注意事项

如果直接使用 npm publish --access public 命令发布的话，发布之前要保证根目录下的 lib 包是最新的，版本号是最新的（之前没有已经发布的版本），所有代码都提交到远程 master 在发布npm版本之后，要执行 npm run pub同步最新的版本到 cdn 以便用来script标签引入来使用

TODO

  • elint+prettier+commit 规范代码开发&提交
  • standard-version 生成版本号、打tag和生成更改日志
  • 支持模块化方式导入和script标签方式使用
  • 打包前检查是否有master最新代码
  • 发布成功之后通知到钉钉群@所有人

SDK 使用

推啊埋点SDK使用文档