testing-tool/AGENTS.md

AGENTS.md

WXT 浏览器扩展项目 (React 19 + TypeScript)。为开发者和测试人员提供浏览器内效率工具集。

功能列表

功能定义见 src/config/features.tsx，PageType 见 src/types/storage.d.ts。

key	页面目录	说明
dashboard	pages/Dashboard	仪表盘首页，工具导航与最近使用
timestamp	pages/Timestamp	Unix 时间戳转换与格式化
storageCleaner	pages/StorageCleaner	清理 Cookies、本地存储、IndexedDB、Cache 等
qrCode	pages/QrCode	二维码生成与解析
textStatistics	pages/TextStatistics	文本字符、单词、行数、字节统计
jwt	pages/Jwt	JWT 解码与查看
jsonTools	pages/JsonTools	JSON 差异比较、格式化、YAML/TOML 转换与压缩
base64Converter	pages/Base64Converter	文本、文件、图像 Base64 编解码
rightClickRestorer	pages/RightClickRestorer	恢复被网站禁用的右键菜单
testDataGenerator	pages/TestDataGenerator	自定义规则批量生成测试数据

核心命令

npm run dev              # Chrome 开发模式 (HMR)
npm run dev:firefox      # Firefox 开发模式
npm run build            # Chrome 生产构建
npm run build:firefox    # Firefox 生产构建
npm run zip              # 打包 Chrome 扩展 (.output/*.zip)
npm run zip:firefox      # 打包 Firefox 扩展
npm run lint             # ESLint (--max-warnings=0)
npm run typecheck        # tsc --noEmit
npm run test             # vitest run (单次执行)
npm run test:watch       # vitest 监视模式
npm run test:coverage    # 带覆盖率的测试
npx vitest run path/to/file.test.ts   # 运行单个测试文件
npx wxt prepare          # 重新生成 .wxt/ 类型声明（npm install 时 postinstall 会自动执行）

修改 package.json 或首次克隆仓库后需执行 npm install，会自动触发 postinstall → wxt prepare。

验证流程

详见 CI 配置。本地与 CI 的检查层次如下。

Pre-commit（.husky/pre-commit）

1. 后台运行 tsc --noEmit（不阻塞提交，结果输出到 stderr）
2. 前台运行 lint-staged：
   • 代码文件 (*.{ts,tsx,js,jsx,mjs})：eslint --fix --max-warnings=0，再 prettier --write
   • 其他文件 (*.{json,css,scss,md})：prettier --write

Pre-push（.husky/pre-push）

1. 全项目 tsc --noEmit（阻塞推送）
2. 对本次推送相对 upstream（或 origin/main）变更的 *.{ts,tsx,js,jsx,mjs} 文件运行 eslint --max-warnings=0

CI（GitHub Actions）

1. setup — 安装依赖
2. 并行 lint、typecheck（含 wxt prepare）、test
3. build — Chrome + Firefox 矩阵构建（仅当步骤 2 全部通过）

项目结构

src/                     # 源代码根目录
  config/features.tsx      # 功能定义（路由 + 元数据的单一事实来源）
  entrypoints/             # 扩展入口点 (popup/, sidepanel/, background.ts, content.ts)
  layout/                  # 应用壳层布局（TopBar 导航、搜索、主题切换）
  pages/                   # 功能页面组件 (懒加载)
  components/              # 可复用 UI 组件
  components/ui/           # shadcn/ui 基础组件 (button, dialog, select 等)
  providers/               # React Context (Router, Theme 等)
  hooks/                   # 自定义 React Hooks
  utils/                   # 工具函数与服务抽象
  types/                   # TypeScript 类型声明
  lib/                     # 通用工具函数（cn、utils）及数据生成器定义
  workers/                 # Web Worker（数据生成等耗时任务）
spec/                    # 功能规格、修复方案与验收标准（见 spec/README.md）
public/                  # 静态资源（图标、_locales 等）
.wxt/                    # wxt prepare 自动生成，含类型声明与扩展 tsconfig（勿手动编辑）
.output/                 # 生产构建输出目录

layout/

应用壳层，与 popup / sidepanel / tab 入口绑定。当前含 TopBar/（搜索、主题切换、返回导航、「在标签页打开」），遵循与 pages/ 相同的 UI + Hook 模式。详见 layout/README.md。

spec/

功能规格与验收标准文档，重大改动前优先查阅。索引见 spec/README.md。

页面组件模式

典型功能页面遵循 UI + Hook 分离 模式。详见 CODING_STANDARDS.md § 11。

src/pages/FeatureName/
├── index.tsx              # 页面 UI（纯展示，仅负责渲染布局）
├── useFeatureName.ts      # 业务逻辑 Hook（状态管理 + 转换逻辑）
├── constants.ts           # 常量定义（可选，≥3 个常量时创建）
└── __tests__/
    └── index.test.tsx

• 页面入口组件统一命名为 Index，通过 export default function Index() 导出
• Hook 负责所有状态管理和业务逻辑，通过返回值暴露给页面
• 子组件可以独立调用全局 Hook
• 当 index.tsx 超过 150 行时，必须拆分为 UI + Hook 模式
• 复杂页面可增加 contexts/、hooks/、components/ 子目录

关键架构决策

路由: 不使用 React Router。通过 src/config/features.tsx 的 FEATURES 数组管理，RouterProvider 根据 PageType 渲染对应组件。支持三种渲染模式：popup（弹窗）、sidepanel（侧边栏）和 tab（浏览器新标签页，TopBar「在标签页打开」调用 openExtensionPage('popup.html', { mode: 'tab' })，由 getEntryPointType() 根据 URL 参数 mode=tab 识别）。 每种模式有独立的路由和可见页面配置（app/popupRoute、app/sidepanelRoute、app/tabRoute 等）。

存储: 所有 Chrome Storage 键必须在 src/types/storage.d.ts 的 StorageSchema 中定义，键名使用 kebab-case 格式（如 app/currentRoute）。 使用 src/utils/chromeStorage.ts 及其 Hook。Router 同时使用 chrome.storage.local 和 localStorage 做快照以消除首屏闪烁。

通信: 使用 @webext-core/messaging，协议定义在 src/utils/messages.ts。

路径别名: @/ 映射到 src/ 目录（已在 .wxt/tsconfig.json 和 vitest.config.ts 中配置）。项目根目录使用 @@/。

浏览器兼容: 优先使用 wxt/browser 导出的 browser 对象，而非原生 chrome API。

测试环境

• 环境: jsdom
• 全局变量: vitest/globals (describe, it, expect 等无需导入)
• Setup 文件: vitest.setup.ts 自动 mock:
  • chrome.* / browser.* API (storage, tabs, runtime, cookies 等)
  • window.matchMedia
• 测试文件命名: __tests__/*.test.{ts,tsx} 或 *.test.{ts,tsx}
• Mock 模式: 使用 vi.mock() 进行模块级 mock，避免在测试文件中重复 mock 代码
• 测试工具: @testing-library/react + @testing-library/user-event 进行组件测试

代码规范

• 禁止使用 any (测试文件除外)
• 未使用变量/参数: 使用 _ 前缀 (如 _unused)
• 样式: 使用 Tailwind CSS + shadcn/ui (通过 className 和 cn() 工具)
• UI 组件: 优先使用 src/components/ui/ 下的 shadcn/ui 组件 (button, dialog, select 等)
• 图标: 使用 lucide-react 图标库
• 格式: Prettier 配置
• ESLint 使用 typescript-eslint 的 projectService: true
• Git Commit: 使用中文描述，遵循 Conventional Commits 规范

关键外部库（非显而易见的）

• @webext-core/messaging — 扩展消息通信
• @dnd-kit — 拖拽排序（用于页面顺序管理和字段列表排序）
• qrious + qr-scanner — 二维码生成与解析
• dayjs — 日期处理（时间戳转换）
• sonner — Toast 通知