# toolkit **Repository Path**: rhyanne/toolkit ## Basic Information - **Project Name**: toolkit - **Description**: 一个基于 Vue 3 + Vite 构建的在线实用工具箱,汇集了日常开发和生活常用的多种小工具。 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-09-06 - **Last Updated**: 2026-10-13 ## Categories & Tags **Categories**: Uncategorized **Tags**: Vue, TypeScript, Pnpm, oxc, vite ## README # Toolkit 一个基于 Vue 3 + Vite 构建的在线实用工具箱,汇集了日常开发和生活常用的多种小工具。 ## 功能特性 - **Base64 编码/解码**:支持文本与 Base64 格式之间的快速转换。 - **图片转 Base64**:将本地图片文件转换为 Base64 DataURL 字符串。 - **URL 编码**:对 URL 进行编码,支持 encodeURI(保留结构字符)和 encodeURIComponent(全量转义)。 - **URL 解码**:对 URL 进行解码,支持 decodeURI 和 decodeURIComponent。 - **JSON 格式化**:提供 JSON 数据的美化(缩进)与压缩功能。 - **UUID 生成器**:快速生成符合标准的 UUID。 - **身份证号生成器**:可以按地区、生日、性别生成符合校验规则的中国身份证号码。 - **中文姓名生成器**:支持多种风格(如武侠、言情、现代等)的中文姓名生成。 - **URL 解析**:详细解析 URL 字符串的结构。 ## 技术栈 - **前端框架**: Vue 3.5 + TypeScript - **构建工具**: Vite 8(Rolldown 后端) - **UI 组件库**: [Nuxt UI 4](https://ui.nuxt.com/)(`@nuxt/ui`,Vue + Vite 模式,含 Reka UI + Tailwind CSS) - **样式**: Tailwind CSS v4(CSS-first `@theme` 语义色)+ [Iconify](https://icones.js.org) 图标 - **包管理**: pnpm ## 快速开始 ### 1. 克隆项目 ```bash git clone https://gitee.com/rhyanne/toolkit.git cd toolkit ``` ### 2. 安装依赖 本项目推荐使用 pnpm 进行依赖管理: ```bash pnpm install ``` ### 3. 启动开发服务器 ```bash pnpm run dev ``` 启动成功后,在浏览器中打开显示的地址(通常是 `http://localhost:5173`)即可使用工具箱。 ### 4. 构建生产版本 构建后的文件将生成在 `dist` 目录中: ```bash pnpm run build ``` ### 5. 质量检查 ```bash pnpm run lint # oxlint pnpm run format:check # oxfmt pnpm exec vitest run # 单元测试 ``` ## 项目结构 ``` src/ ├── assets/ # 静态资源文件 ├── components/ # 全局通用组件(ToolLayout / ToolPanel / ToolControls) ├── composables/ # 组合式函数 (Hooks) │ ├── useChineseNameGenerator.ts # 中文姓名生成逻辑 │ ├── useTheme.ts # 主题切换逻辑 │ ├── useClipboard.ts # 剪贴板操作 │ ├── useCopyFeedback.ts # 复制三态反馈 │ └── useTextTransform.ts # 文本转换工具统一 IO 状态机 ├── lib/ # 核心库(tool-registry / types / utils / errors / list.json) ├── tools/ # 工具模块目录(9 个工具) │ ├── url-encoder/ # URL 编码 │ ├── url-decoder/ # URL 解码 │ ├── url-parser/ # URL 解析 │ ├── base64-encoder/ # Base64 编码/解码 │ ├── chinese-name-generator/ # 中文姓名生成器 │ ├── json-formatter/ # JSON 格式化 │ ├── idcard/ # 随机身份证号(开发测试用) │ ├── imagebase64/ # 图片转 Base64 │ └── uuid/ # UUID 生成器(v4/v7) ├── views/ # 页面视图(HomePage / NotFoundPage) ├── router/ # Vue Router(工具路由经 ToolMeta.routes 自动并入) ├── App.vue # 根组件 └── main.ts # 入口(initTheme + initializeTools + 挂载) ``` ## 如何贡献 1. **Fork** 本仓库。 2. 创建您的特性分支 (`git checkout -b feature/NewTool`)。 3. 新增工具遵循[工具开发 SOP](docs/planning/tool-sop.md),仓库约定见 [AGENTS.md](AGENTS.md)。 4. 提交信息遵循[提交规范](COMMIT-CONVENTION.md)(中文描述、动词开头、不写追溯编号)。 5. 提交前执行 `pnpm run verify`(lint + 格式 + 类型检查 + 单测 + 构建),全绿后再提交。 6. 提交您的改动 (`git commit`),推送到 Gitee (`git push origin feature/NewTool`)。 7. 提交 **Pull Request** 申请合并。 ## 许可证 本项目基于 [MIT License](LICENSE) 开源。