docs(工程文档): 格式化文档表格
Co-authored-by: LingandRX <LingandRX@users.noreply.github.com>
This commit is contained in:
Cursor Agent
+2
-2
@@ -18,8 +18,8 @@
|
|||||||
|
|
||||||
项目使用 Chrome 扩展标准 `chrome.i18n`，默认语言在 `wxt.config.ts` 中配置为 `zh_CN`。
|
项目使用 Chrome 扩展标准 `chrome.i18n`，默认语言在 `wxt.config.ts` 中配置为 `zh_CN`。
|
||||||
|
|
||||||
| 文件/目录 | 用途 |
|
| 文件/目录 | 用途 |
|
||||||
| --------------------------- | -------------------------------- |
|
| ------------------------------ | -------------------------------------------------- |
|
||||||
| `_locales/zh_CN/messages.json` | 默认中文语言包，包含功能名、描述、按钮、提示等翻译 |
|
| `_locales/zh_CN/messages.json` | 默认中文语言包，包含功能名、描述、按钮、提示等翻译 |
|
||||||
|
|
||||||
添加或修改文案时：
|
添加或修改文案时：
|
||||||
|
|||||||
+12
-12
@@ -4,10 +4,10 @@
|
|||||||
|
|
||||||
## 文件说明
|
## 文件说明
|
||||||
|
|
||||||
| 文件/目录 | 用途 |
|
| 文件/目录 | 用途 |
|
||||||
| --------------- | ------------------------------------------------ |
|
| ------------- | -------------------------------------- |
|
||||||
| `utils.ts` | `cn()` 函数 — shadcn/ui 标准工具函数 |
|
| `utils.ts` | `cn()` 函数 — shadcn/ui 标准工具函数 |
|
||||||
| `generators/` | 测试数据生成器内置生成器库和分类注册表 |
|
| `generators/` | 测试数据生成器内置生成器库和分类注册表 |
|
||||||
|
|
||||||
## cn()
|
## cn()
|
||||||
|
|
||||||
@@ -30,14 +30,14 @@ import { cn } from '@/lib/utils';
|
|||||||
|
|
||||||
测试数据生成器的核心生成器库，供 `src/workers/generator.worker.ts` 在后台线程中按字段配置生成数据。
|
测试数据生成器的核心生成器库，供 `src/workers/generator.worker.ts` 在后台线程中按字段配置生成数据。
|
||||||
|
|
||||||
| 文件 | 用途 |
|
| 文件 | 用途 |
|
||||||
| ------------- | ------------------------------------------------ |
|
| -------------- | ---------------------------------------------- |
|
||||||
| `index.ts` | 聚合所有生成器，导出分类、查找和搜索函数 |
|
| `index.ts` | 聚合所有生成器，导出分类、查找和搜索函数 |
|
||||||
| `personal.ts` | 个人信息生成器（姓名、邮箱、手机号、身份证等） |
|
| `personal.ts` | 个人信息生成器（姓名、邮箱、手机号、身份证等） |
|
||||||
| `business.ts` | 业务数据生成器（订单号、价格、日期、状态等） |
|
| `business.ts` | 业务数据生成器（订单号、价格、日期、状态等） |
|
||||||
| `technical.ts`| 技术数据生成器（UUID、IPv4、URL） |
|
| `technical.ts` | 技术数据生成器（UUID、IPv4、URL） |
|
||||||
| `basic.ts` | 基础类型生成器（整数、浮点数、布尔值、字符串） |
|
| `basic.ts` | 基础类型生成器（整数、浮点数、布尔值、字符串） |
|
||||||
| `types.ts` | 生成器库内部类型与通用选项 |
|
| `types.ts` | 生成器库内部类型与通用选项 |
|
||||||
|
|
||||||
使用示例：
|
使用示例：
|
||||||
|
|
||||||
|
|||||||
+8
-8
@@ -126,14 +126,14 @@ Base64 编解码工具，支持文本/文件/图片三种模式。
|
|||||||
|
|
||||||
测试数据生成器，支持可视化字段配置、规则复用、Web Worker 批量生成和 JSON/CSV 导出。
|
测试数据生成器，支持可视化字段配置、规则复用、Web Worker 批量生成和 JSON/CSV 导出。
|
||||||
|
|
||||||
| 文件/目录 | 用途 |
|
| 文件/目录 | 用途 |
|
||||||
| ---------------------------- | -------------------------------------------------- |
|
| ---------------------------- | ------------------------------------------------- |
|
||||||
| `index.tsx` | 主页面，管理字段配置、规则标签页和生成结果 |
|
| `index.tsx` | 主页面，管理字段配置、规则标签页和生成结果 |
|
||||||
| `hooks/useGenerator.ts` | Worker 生命周期与消息通信，暴露生成/取消/清理操作 |
|
| `hooks/useGenerator.ts` | Worker 生命周期与消息通信，暴露生成/取消/清理操作 |
|
||||||
| `components/FieldList.tsx` | 字段列表、拖拽排序、虚拟滚动和规则保存入口 |
|
| `components/FieldList.tsx` | 字段列表、拖拽排序、虚拟滚动和规则保存入口 |
|
||||||
| `components/FieldEditor.tsx` | 字段名称、生成器、参数、必填/空值率/唯一性配置 |
|
| `components/FieldEditor.tsx` | 字段名称、生成器、参数、必填/空值率/唯一性配置 |
|
||||||
| `components/RuleManager.tsx` | 规则搜索、加载、编辑、复制、删除、导入和导出 |
|
| `components/RuleManager.tsx` | 规则搜索、加载、编辑、复制、删除、导入和导出 |
|
||||||
| `components/ExportPanel.tsx` | 生成结果复制和 JSON/CSV 下载 |
|
| `components/ExportPanel.tsx` | 生成结果复制和 JSON/CSV 下载 |
|
||||||
|
|
||||||
约束与注意事项：
|
约束与注意事项：
|
||||||
|
|
||||||
|
|||||||
+21
-21
@@ -4,27 +4,27 @@
|
|||||||
|
|
||||||
## 工具函数
|
## 工具函数
|
||||||
|
|
||||||
| 文件 | 用途 |
|
| 文件 | 用途 |
|
||||||
| -------------------- | --------------------------------------------------------------------------------------------------- |
|
| ------------------------ | --------------------------------------------------------------------------------------------------- |
|
||||||
| `chromeStorage.ts` | Chrome Storage API 封装：类型安全的 `StorageUtils` 类，提供 `get/set/remove` 方法 |
|
| `chromeStorage.ts` | Chrome Storage API 封装：类型安全的 `StorageUtils` 类，提供 `get/set/remove` 方法 |
|
||||||
| `chromeTabs.ts` | Chrome Tabs API 封装：获取活动标签页、获取域名、在新标签页打开扩展页面 |
|
| `chromeTabs.ts` | Chrome Tabs API 封装：获取活动标签页、获取域名、在新标签页打开扩展页面 |
|
||||||
| `clipboard.ts` | 剪贴板操作：`copyTextToClipboard`（文本）、`copyImageToClipboard`（图片） |
|
| `clipboard.ts` | 剪贴板操作：`copyTextToClipboard`（文本）、`copyImageToClipboard`（图片） |
|
||||||
| `messages.ts` | 扩展消息通信：基于 `@webext-core/messaging`，定义 `MessageAction` 枚举和 `ProtocolMap` 类型安全映射 |
|
| `messages.ts` | 扩展消息通信：基于 `@webext-core/messaging`，定义 `MessageAction` 枚举和 `ProtocolMap` 类型安全映射 |
|
||||||
| `contextMenu.ts` | 右键菜单配置与操作：定义菜单项、创建菜单、解析点击事件、ID→PageType 映射 |
|
| `contextMenu.ts` | 右键菜单配置与操作：定义菜单项、创建菜单、解析点击事件、ID→PageType 映射 |
|
||||||
| `base64Converter.ts` | Base64 编解码：文本↔Base64、文件↔Base64、图片预览，定义文件大小限制和图像 MIME 类型 |
|
| `base64Converter.ts` | Base64 编解码：文本↔Base64、文件↔Base64、图片预览，定义文件大小限制和图像 MIME 类型 |
|
||||||
| `jwt.ts` | JWT 解析：Base64URL 解码、解析 Header/Payload/Signature、JSON 格式化输出 |
|
| `jwt.ts` | JWT 解析：Base64URL 解码、解析 Header/Payload/Signature、JSON 格式化输出 |
|
||||||
| `jsonFormatter.ts` | JSON 格式化/压缩：支持缩进、按键排序、minify |
|
| `jsonFormatter.ts` | JSON 格式化/压缩：支持缩进、按键排序、minify |
|
||||||
| `jsonToYaml.ts` | JSON→YAML 转换 |
|
| `jsonToYaml.ts` | JSON→YAML 转换 |
|
||||||
| `jsonToToml.ts` | JSON→TOML 转换 |
|
| `jsonToToml.ts` | JSON→TOML 转换 |
|
||||||
| `qrCodeParser.ts` | 二维码解析：基于 `qr-scanner` 库从文件中解析二维码 |
|
| `qrCodeParser.ts` | 二维码解析：基于 `qr-scanner` 库从文件中解析二维码 |
|
||||||
| `storageCleaner.ts` | 存储清理：获取当前标签页、检测受限 URL、计算 Cookie/Storage 大小、清理操作 |
|
| `storageCleaner.ts` | 存储清理：获取当前标签页、检测受限 URL、计算 Cookie/Storage 大小、清理操作 |
|
||||||
| `textStatistics.ts` | 文本统计：使用 `Intl.Segmenter` 计算字符数/单词数/行数/字节大小 |
|
| `textStatistics.ts` | 文本统计：使用 `Intl.Segmenter` 计算字符数/单词数/行数/字节大小 |
|
||||||
| `format.ts` | 通用格式化：`formatBytes` 将字节转为可读字符串（B/KB/MB/GB/TB） |
|
| `format.ts` | 通用格式化：`formatBytes` 将字节转为可读字符串（B/KB/MB/GB/TB） |
|
||||||
| `dayjs.ts` | Day.js 初始化：扩展 UTC、Timezone、RelativeTime 插件，加载中文本地化 |
|
| `dayjs.ts` | Day.js 初始化：扩展 UTC、Timezone、RelativeTime 插件，加载中文本地化 |
|
||||||
| `chromeI18n.ts` | Chrome `chrome.i18n` 包装：提供 `getMessage` 和兼容 React 使用的 `useI18n` Hook |
|
| `chromeI18n.ts` | Chrome `chrome.i18n` 包装：提供 `getMessage` 和兼容 React 使用的 `useI18n` Hook |
|
||||||
| `ruleStorage.ts` | 测试数据生成器规则存储：基于 `localStorage` 的 CRUD、搜索、导入/导出和数量限制 |
|
| `ruleStorage.ts` | 测试数据生成器规则存储：基于 `localStorage` 的 CRUD、搜索、导入/导出和数量限制 |
|
||||||
| `dataExporter.ts` | 测试数据导出：JSON/CSV 转换、文件下载和复制到剪贴板 |
|
| `dataExporter.ts` | 测试数据导出：JSON/CSV 转换、文件下载和复制到剪贴板 |
|
||||||
| `rightClickInjection.ts` | 右键恢复注入脚本：在页面上下文恢复 contextmenu/copy/paste 等事件默认行为 |
|
| `rightClickInjection.ts` | 右键恢复注入脚本：在页面上下文恢复 contextmenu/copy/paste 等事件默认行为 |
|
||||||
|
|
||||||
## 自定义 Hooks
|
## 自定义 Hooks
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user