Skip to content

CLAUDE.md

Latest commit

 

History

History
51 lines (32 loc) · 2.05 KB

CLAUDE.md

File metadata and controls

51 lines (32 loc) · 2.05 KB
Raw

项目概述

BLTH（Bilibili Live Tasks Helper）是基于 Vue 3 + Vite + vite-plugin-monkey + Element Plus + TypeScript 的用户脚本（Userscript），通过用户脚本管理器（Tampermonkey/Violentmonkey）运行在 Bilibili 直播页面（https://live.bilibili.com/直播间号），实现自动完成每日任务、观看体验优化和页面元素清理。

常用命令

npm run dev          # 启动 Vite 开发服务器并安装脚本（支持 HMR）
npm run build        # type-check 与 build+minify 并行
npm run type-check   # 仅 Vue TypeScript 类型检查
npm run lint         # ESLint + Stylelint 自动修复
npm run format       # 使用 Prettier 格式化 src/
npm run preview      # 打开提供编译产物安装链接的本地预览网页

无自动化测试。

架构

模块系统

所有模块继承 src/modules/BaseModule.ts，由 src/stores/useModuleStore.ts 管理生命周期。

模块分两类：

  • 默认模块（src/modules/default/）：做准备工作，如基础数据获取，先于大多数功能模块加载
  • 功能模块：实现具体业务逻辑，如完成每日任务

配置持久化

src/library/storage/ 通过 GM_setValue/GM_getValue 存取配置。

多标签页安全

脚本分三类：Main，SubMain，Other。同时打开多个直播间页面时，src/stores/useCacheStore.ts 会选出唯一 Main 脚本，避免部分模块重复加载。

分支

  • master：发布分支。合并来自 dev 的 PR 后触发 GitHub Actions 自动构建并创建 Release
  • dev：开发分支。非发布 PR 的目标分支

规范

  • src/library/bili-api/ 中的 API 必须有详细的请求/响应类型定义
  • 路径别名 @/ 映射到 src/
  • Commit message 使用约定式提交格式

易踩坑点

  • 新增第三方库须写进 vite.config.ts 的 externalGlobals/externalResource 中，通过 @require/@resource 引入，不打包进脚本
  • 调试早期模块（runAt = 'document-start'）时 dev 模式注入太晚，请用 npm run build 的产物测试