create-ai-toolkit
MIT License
功能
1. 自动生成组件
create-ai-toolkit 能够根据用户提供的需求描述，自动生成符合规范的前端组件，减少重复劳动，让开发者能够专注于核心业务逻辑。
特点：
- 支持多种前端框架（如 React、Vue）。
- 自动生成 TypeScript 类型定义。
- 可选的 CSS 预处理器集成（如 SASS、LESS、Stylus、Tailwind CSS）等。
- 自动生成 TypeDoc 注释，快速掌握使用方法。
2. 自定义 Hooks 生成
该工具能够根据需求描述生成自定义的 hooks，提高代码复用性和可维护性。
特点：
- 支持多种前端框架（如 React、Vue）。
- 支持复杂的状态管理和副作用处理。
- 自动生成 TypeDoc 注释，快速掌握使用方法。
- 与现有组件无缝集成。
3. 智能提交信息生成
create-ai-toolkit 可以根据暂存区的内容自动生成提交信息，确保提交历史清晰、规范。
特点：
- 基于代码变更内容生成提交信息。
- 支持多种提交信息格式（如 Conventional Commits）。
- 提高提交效率，减少人为错误。
4. 代码审查和优化
该工具能够对代码进行静态分析和审查，提供优化建议，帮助开发者提升代码质量。
特点：
- 识别代码中的潜在问题和反模式。
- 提供代码优化建议和最佳实践。
- 支持多种编程语言和框架。
使用指南
1. 安装
确保你的 Node.js 版本在 v18 以上，并全局安装 create-ai-toolkit：
npm install -g create-ai-toolkit-test
# 或者使用 pnpm
pnpm add -g create-ai-toolkit-test
2. 添加 API Key
如果你没有 GPT 的 key，可以前往 OpenAI 官方网站进行购买。
3. 设置 API Key
要使用 create-ai-toolkit，首先需要执行以下命令来全局设置 API Key：
ai set OPENAI_KEY 你的key
此命令会在你的操作系统根目录创建一个 toolkit.config.json 文件。
4. 查看帮助
在终端中执行以下命令：
ai --help
你会看到如下效果：
具体功能演示
1. 自动生成组件
执行以下命令来自动生成组件：
ai component <name> [path]
其中，name 为组件名，path 为可选参数，指定生成文件的路径，默认在 src/components 目录下。
执行命令并根据需求进行选择，最终结果如下图所示：
2. 自定义 Hooks 生成
执行以下命令来生成自定义 Hooks：
ai hooks <name>
其中，name 为 Hooks 文件的名字，默认在 src/hooks 目录下。
执行命令并根据需求进行选择，最终结果如下图所示：
3. 自动生成提交信息
要生成提交信息，首先确保你的 git 暂存区内有内容。执行以下命令将修改的文件添加到暂存区：
git add .
确保暂存区内有内容后，执行以下命令：
ai commit
终端会返回适当的提交信息供你选择：
如果选择满意的提交信息，工具会自动执行 git commit -m '生成的提交信息'。
4. 自动生成 Code Review
根据暂存区内的内容，AI 会自动为你的修改做 Code Review 并提供修改意见。执行以下命令：
ai review
执行命令后，AI 会自动生成一个 moment.md 文件，包含 AI 提供的评价和修改建议：
配置
更换 API Key
如果需要更换 API Key，可以执行以下命令：
ai set OPENAI_KEY 你的key
获取当前设置的 API Key
执行以下命令获取当前设置的 API Key：
ai get OPENAI_KEY
更换 API 端点
如果使用的是其他中转的 API Key 或在本机上运行的大模型，可以执行以下命令来更换 API 端点：
ai set END_POINT http://127.0.0.1:8000
获取当前设置的 API 端点
执行以下命令获取当前设置的 API 端点：
ai get END_POINT
贡献者
感谢所有为这个项目做出贡献的人！