UNPKG

codec-ai

Version:

Codec AI - 智能代码生成和编程助手,支持多语言代码生成、项目脚手架、代码转换和优化

236 lines (169 loc) 5.52 kB
# Codec 🚀 **Codec** - 智能代码生成和编程助手 基于 Claude Code、Codex 和 CodeBuddy 的设计理念,为您提供强大的命令行代码生成和项目管理工具。 ## ✨ 主要特性 - **🎯 智能代码生成** - 根据描述自动生成高质量的代码 - **🏗️ 项目脚手架** - 一键创建完整的项目结构 - **🔄 代码转换** - 在不同编程语言间转换代码 - **✨ 代码优化** - 分析和优化代码质量 - **📚 模板管理** - 创建和应用代码模板 - **🇨🇳 中文界面** - 全中文交互界面和文档 ## 🚀 快速开始 ### 安装 ```bash # 克隆项目 git clone <repository-url> cd codec # 安装依赖 npm install # 构建项目 npm run build # 全局安装 npm link ``` ### 基本使用 ```bash # 查看帮助 codec --help # 生成代码 codec 生成 # 创建项目 codec 项目 # 代码转换 codec 转换 # 代码优化 codec 优化 # 模板管理 codec 模板 ``` ## 📖 详细功能说明 ### 1. 代码生成 (`claude-code 生成`) 根据功能描述生成各种编程语言的代码: - **支持语言**: JavaScript, TypeScript, Python, Java, Go, Rust - **代码类型**: 函数、类、组件、API、测试用例 - **交互模式**: 提供友好的交互式界面 **示例**: ```bash claude-code 生成 -l javascript -t function -d "计算两个数的和" ``` ### 2. 项目管理 (`claude-code 项目`) 创建完整的项目结构: - **项目类型**: Web应用、API服务、CLI工具、库包 - **框架支持**: React、Vue、Express、NestJS、FastAPI等 - **语言支持**: JavaScript、TypeScript、Python、Java、Go **示例**: ```bash claude-code 项目 -n my-app -t web -l typescript -f react-ts ``` ### 3. 代码转换 (`claude-code 转换`) 在不同编程语言间转换代码: - **支持转换**: JavaScript ↔ TypeScript ↔ Python - **文件分析**: 自动识别语言和结构 - **智能转换**: 保持代码逻辑和语义 **示例**: ```bash claude-code 转换 -s source.js -f javascript -t python ``` ### 4. 代码优化 (`claude-code 优化`) 分析和优化代码质量: - **质量分析**: 代码重复率、函数复杂度 - **性能检查**: 循环优化、内存泄漏检测 - **安全检查**: SQL注入、XSS漏洞检测 **示例**: ```bash claude-code 优化 -f src/index.js -t quality ``` ### 5. 模板管理 (`claude-code 模板`) 管理代码模板库: - **模板创建**: 创建自定义代码模板 - **模板应用**: 快速应用模板到项目 - **模板分享**: 导出和导入模板 **示例**: ```bash # 查看模板列表 claude-code 模板 列表 # 创建新模板 claude-code 模板 创建 my-template # 应用模板 claude-code 模板 应用 my-template ``` ## 🏗️ 项目结构 ``` claude-code-cli/ ├── src/ │ ├── cli.ts # 主入口文件 │ ├── commands/ # 命令模块 │ │ ├── generate.ts # 代码生成命令 │ │ ├── project.ts # 项目管理命令 │ │ ├── convert.ts # 代码转换命令 │ │ ├── optimize.ts # 代码优化命令 │ │ └── template.ts # 模板管理命令 │ ├── core/ # 核心引擎 │ │ ├── generator.ts # 代码生成器 │ │ ├── scaffolder.ts # 项目脚手架 │ │ ├── converter.ts # 代码转换器 │ │ ├── optimizer.ts # 代码优化器 │ │ └── template.ts # 模板管理器 │ └── utils/ # 工具函数 ├── dist/ # 编译输出目录 ├── package.json ├── tsconfig.json └── README.md ``` ## 🔧 开发指南 ### 本地开发 ```bash # 安装依赖 npm install # 开发模式 npm run dev # 构建项目 npm run build # 运行测试 npm test # 代码检查 npm run lint ``` ### 添加新功能 1.`src/commands/` 中添加新命令 2.`src/core/` 中实现核心逻辑 3. 更新 `src/cli.ts` 注册新命令 4. 添加相应的测试用例 ### 扩展语言支持`src/core/generator.ts``templates` 对象中添加新语言的模板: ```typescript const templates = { newLanguage: { function: (desc: string) => `// ${desc} 的函数实现`, class: (desc: string) => `// ${desc} 的类实现` } }; ``` ## 📋 支持的编程语言 | 语言 | 代码生成 | 项目模板 | 代码转换 | 代码优化 | |------|----------|----------|----------|----------| | JavaScript | ✅ | ✅ | ✅ | ✅ | | TypeScript | ✅ | ✅ | ✅ | ✅ | | Python | ✅ | ✅ | ✅ | ✅ | | Java | ✅ | ✅ | 🔄 | 🔄 | | Go | ✅ | ✅ | 🔄 | 🔄 | | Rust | ✅ | 🔄 | 🔄 | 🔄 | ## 🤝 贡献指南 我们欢迎任何形式的贡献! 1. Fork 项目 2. 创建功能分支 (`git checkout -b feature/AmazingFeature`) 3. 提交更改 (`git commit -m 'Add some AmazingFeature'`) 4. 推送到分支 (`git push origin feature/AmazingFeature`) 5. 开启 Pull Request ## 📄 许可证 本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。 ## 🙏 致谢 - 灵感来源于 Claude Code、Codex 和 CodeBuddy - 使用 Commander.js 构建命令行界面 - 感谢所有贡献者的支持 ## 📞 联系方式 - 问题反馈: [GitHub Issues](issues-url) - 功能建议: [GitHub Discussions](discussions-url) - 邮件联系: contact@example.com --- **Made with ❤️ by Claude Code Team**