Iris Development Notes 1 | Obsidian Plugin Development

overview

视频演示

项目架构

1. 整体架构

项目采用了典型的 MVC 架构模式，主要分为以下几层：

src/
├── main.ts              # 控制器层：插件主入口
├── views/               # 视图层：UI组件
├── services/            # 服务层：核心业务逻辑
├── utils/              # 工具层：通用功能
└── interface.ts        # 接口定义层

详细展开的文件树如下：

project/
├── src/                      # 源代码目录
│   ├── main.ts              # 插件主入口
│   │   - 插件初始化
│   │   - 服务注册
│   │   - 命令注册
│   │   - 视图注册
│   │
│   ├── interface.ts         # 接口定义
│   │   - Document          # 文档接口
│   │   - VectorStore       # 向量存储接口
│   │   - OllamaConfig      # Ollama配置接口
│   │   - IrisSettings      # 插件设置接口
│   │   - IrisAction        # 动作接口
│   │   - IrisWorkflow      # 工作流接口
│   │
│   ├── defaultSettings.ts   # 默认配置
│   │   - DEFAULT_ACTIONS   # 预设动作列表
│   │   - DEFAULT_WORKFLOWS # 预设工作流
│   │   - DEFAULT_SETTINGS  # 默认插件设置
│   │
│   ├── settings.ts         # 设置页面
│   │   - IrisSettingTab    # 设置标签页组件
│   │   - 动作管理界面
│   │   - 参数配置界面
│   │
│   ├── services/           # 核心服务目录
│   │   ├── langchain.ts    # LangChain服务
│   │   │   - 查询处理
│   │   │   - RAG增强
│   │   │   - 动作执行
│   │   │
│   │   ├── ollama.ts       # Ollama服务
│   │   │   - API调用
│   │   │   - 向量嵌入
│   │   │
│   │   ├── indexer.ts      # 索引服务
│   │   │   - 文档索引
│   │   │   - 向量检索
│   │   │
│   │   └── local-vector-store.ts  # 本地向量存储
│   │       - 向量存储
│   │       - 相似度搜索
│   │
│   ├── views/              # 视图组件目录
│   │   └── chat-view.ts    # 聊天界面
│   │       - 消息渲染
│   │       - 动作执行
│   │       - 交互处理
│   │
│   └── utils/              # 工具函数目录
│       └── helper.ts       # 辅助函数
│
├── styles/                 # 样式目录
│   └── styles.css         # 主样式文件
│
├── manifest.json          # 插件清单
└── package.json          # 项目配置

2. 核心模块分析

2.1 控制器层 (main.ts)

export default class Iris extends Plugin {
  private langchain: LangChainService;
  private ollamaService: OllamaService;
  private vectorStore: LocalVectorStore;
  public indexer: ObsidianIndexer;

  async onload() {
    // 1. 初始化服务
    // 2. 注册视图
    // 3. 添加命令
    // 4. 设置状态栏
  }
}

主要职责：

服务初始化和生命周期管理
视图注册
命令注册
状态管理

2.2 服务层 (services/)

LangChain服务 (langchain.ts)

export class LangChainService {
  // RAG查询
  async ragQuery(question: string, callback: (chunk: StreamMessage) => void);

  // 对话查询
  async chatQuery(input: string, callback: (chunk: StreamMessage) => void);

  // 执行动作
  async executeAction(action: IrisAction, input: string);
}

Ollama服务 (ollama.ts)

export class OllamaService {
  // 嵌入生成
  async embedDocuments(texts: string[]): Promise<number[][]>;

  // 查询嵌入
  async embedQuery(text: string): Promise<number[]>;

  // 连接测试
  async testConnection(): Promise<boolean>;
}

索引服务 (indexer.ts)

export class ObsidianIndexer {
  // 索引仓库
  async indexVault(options?: IndexOptions);

  // 相似搜索
  async searchSimilar(query: string, limit: number);
}

2.3 视图层 (views/)

聊天视图 (chat-view.ts)

promptPreset

mermaid-css

export class IrisChatView extends ItemView {
  // 消息渲染
  private async renderMessage(message: ChatMessage);

  // 动作执行
  private async executeAction(action: IrisAction);

  // 模式切换
  private switchMode(mode: ChatMode);
}

自定义欢迎词

ChatViewSetting

2.4 接口定义 (interface.ts)

// 核心接口定义
export interface {
    ChatMessage,
    StreamMessage,
    Document,
    IrisAction,
    IrisWorkflow,
    // ...
}

3. 数据流转

RagModal

RAG查询流程:

graph LR
    A[用户输入] --> B[IrisChatView]
    B --> C[LangChainService]
    C --> D[向量检索]
    D --> E[生成回答]
    E --> F[渲染结果]

索引流程:

graph LR
    A[触发索引] --> B[ObsidianIndexer]
    B --> C[文档处理]
    C --> D[Ollama嵌入]
    D --> E[本地存储]

4. 特色封装

动作系统

IrisAction

interface IrisAction {
  id: string;
  name: string;
  prompt: string;
  params?: IrisActionParam[];
  quickInputs?: QuickInput[];
}

支持参数配置
快速输入选项
自定义图标

工作流系统

interface IrisWorkflow {
  id: string;
  type: WorkflowType;
  chainType?: "stuff" | "map_reduce" | "refine";
  useRag?: boolean;
  useMemory?: boolean;
}

支持多种链类型（后端langchain实现）
RAG增强选项
记忆管理

状态管理

vaultIndexing

// 状态栏显示
this.statusBarItem = this.addStatusBarItem();
this.statusBarItem.addClass("iris-status-bar-item");

5. 建议优化方向

错误处理体系

添加统一的错误处理机制
实现错误重试策略

缓存机制

添加向量缓存
实现会话缓存

性能优化

实现增量索引
优化大文件处理

用户体验

添加进度反馈
优化加载状态
增强错误提示

和cursor互动合作

.cursorrules

Always respond in 中文

目前你使用的技术框架为原生typescript，开发obsidian插件。（不使用vue等框架！）
请随时记住你的记忆有限，对于你认为多余的代码不要擅自删改，添加新的兼容的代码就好。对于删除的代码，必须给出不得不删除的明确理由。

如果你认为提供的文件不够，请直接提出。

这个项目叫Iris，我希望她作为obsidian插件，有出色的前端交互体验（交互逻辑与style.css渲染），后端能接入ollama等服务，我们自己的后端通过tslangchain框架，进行rag服务。

目前开发mvp产品，最重要的是实现仓库所有文件的索引以及增强检索（RAG与传统检索集合），用户能在settingtab栏设置重新index和自设提示词，以及请求头headder/body，能在obsidian交互页面ribbon actions，command呼出右侧View 右侧视图，status bar 右下角显示加载进度

和Iris命名相关的：IrisSetting IrisTabSetting（设置栏以及设置栏显示，用户自己的设置写入data.json） IrisModalSetting（模态框调用）等

新增的Feature，首先告诉我适合用来作为commit内容的题目，然后在interface.ts里面定义相关接口，main.ts里import调用
和rag以及llm调用相关的，使用langchain.ts以及ollama实现
和索引相关的，使用indexer.ts
文件系统以及editor相关，使用monitor.ts
处理的小工具（比如之后会开发的多模态支持，以及日志系统），放在utils/helpers.ts
以上是默认要求。以下是在具体开发中遇到的问题：

知识点：MVC架构

MVC（Model-View-Controller）架构模式是一种软件设计模式，用于实现用户界面与业务逻辑的分离。它将应用程序分为三个核心组件：模型（Model）、视图（View）和控制器（Controller）。这种模式有助于提高应用程序的可维护性和可扩展性，并且使得开发人员可以专注于各自独立的部分。下面是这三个组件的简要说明：

模型（Model）：
- 代表应用程序的数据结构和业务逻辑。
- 负责数据的存储、检索和操作。
- 通常包括数据验证和设置规则。
视图（View）：
- 负责显示数据（即模型）给用户，并收集用户输入。
- 是用户界面的一部分，用户通过视图与应用程序进行交互。
- 视图不包含业务逻辑，它只负责展示模型的数据和接收用户指令。
控制器（Controller）：
- 作为模型和视图之间的中介。
- 接收用户的输入并调用模型和视图去完成用户的需求。
- 控制应用程序的流程，根据用户的输入调用模型更新数据，然后选择合适的视图显示给用户。

MVC模式的工作原理通常如下：

用户通过视图进行操作，比如点击按钮或输入数据。
控制器接收到用户的输入后，解释这些输入，并调用模型进行相应的业务逻辑处理。
模型处理完业务逻辑后，会更新数据。
控制器通知视图更新显示，以反映模型中的数据变化。

MVC模式的一个关键优点是它支持并行开发，不同的开发人员可以同时工作在模型、视图和控制器上，而不会相互干扰。此外，MVC也有助于测试和调试，因为每个组件都是独立的，可以单独测试。