Skip to content

PROJECT_STRUCTURE.md

Latest commit

 

History

History
134 lines (105 loc) · 2.91 KB

PROJECT_STRUCTURE.md

File metadata and controls

134 lines (105 loc) · 2.91 KB

项目结构说明

vue-ai-stream-helper/
├── src/
│   └── index.js                  # 主文件（核心代码）
├── dist/                         # 构建输出目录（自动生成）
│   └── index.js
├── scripts/
│   └── publish.sh               # 发布脚本
├── package.json                 # NPM包配置
├── README.md                    # 英文文档
├── README.zh-CN.md              # 中文文档
├── EXAMPLES.md                  # 使用示例
├── CHANGELOG.md                 # 更新日志
├── PUBLISH.md                   # 发布指南
├── CONTRIBUTING.md              # 贡献指南
├── LICENSE                      # MIT许可证
├── .gitignore                   # Git忽略文件
└── .npmignore                   # NPM忽略文件

文件说明

核心文件

  • src/index.js - 插件主文件
    • AIStreamChat 类：核心流式处理类
    • createAIChat() 函数：工厂函数
    • streamChat() 函数：快捷方法
    • Vue插件导出

配置文件

  • package.json - NPM包配置
    • 包名、版本、描述
    • 依赖关系
    • 构建脚本
    • 仓库信息

文档文件

  • README.md - 主文档（英文）

    • 功能介绍
    • 安装方法
    • 快速开始
    • API文档

  • README.zh-CN.md - 中文文档

    • 简化版中文说明

  • EXAMPLES.md - 详细示例

    • 基础用法
    • 进阶用法
    • 实际场景

  • PUBLISH.md - 发布指南

    • GitHub发布流程
    • NPM发布流程
    • 版本管理

  • CONTRIBUTING.md - 贡献指南

    • 如何报告Bug
    • 如何提交代码
    • 代码规范

  • CHANGELOG.md - 更新日志

    • 版本历史
    • 变更记录

其他文件

  • LICENSE - MIT许可证
  • .gitignore - Git忽略配置
  • .npmignore - NPM发布时忽略的文件
  • scripts/publish.sh - 自动发布脚本

代码结构

src/index.js 结构

// 1. 核心类定义
class AIStreamChat {
  constructor()        // 初始化配置
  chat()              // 发送聊天请求
  _processStream()    // 处理SSE流
  abort()             // 取消请求
}

// 2. 工厂函数
createAIChat()        // 创建实例

// 3. 快捷方法
streamChat()          // 简化调用

// 4. Vue插件
export default {
  install()           // Vue.use() 调用
}

使用工作流

安装
  ↓
注册插件（main.js）
  ↓
在组件中使用
  ↓
  ├─→ this.$aiChat.chat()     [有状态，可取消]
  └─→ this.$streamChat()      [无状态，简化版]

维护建议

  1. 版本管理

    • 遵循语义化版本
    • 每次发布更新 CHANGELOG.md

  2. 文档维护

    • 新功能及时更新文档
    • 保持示例代码的准确性

  3. 代码质量

    • 保持代码简洁
    • 添加必要注释
    • 完善错误处理

  4. 兼容性

    • 保持向下兼容
    • 重大变更需提升主版本号