openai-compatible-task-master
Version:
使用MCP解析PRD文档并生成任务列表
41 lines (40 loc) • 1.79 kB
TypeScript
import { TaskData, TasksOutput } from '../llm/types.js';
/**
* 从指定路径读取tasks.json文件并验证其格式
* @param projectDir 项目根目录路径
* @param tasksPath 任务文件相对路径
* @returns 验证通过的任务数据
* @throws 当文件不存在或格式不正确时抛出错误
*/
export declare function readTasksFile(projectDir: string, tasksPath: string): Promise<TasksOutput>;
/**
* 筛选需要更新的任务
* @param tasks 任务列表
* @param fromId 起始任务ID(字符串形式)
* @returns 符合条件的任务子集(ID >= fromId且不是done状态)
* @throws 当ID >= fromId的任务中有done状态的任务时抛出错误
*/
export declare function filterTasks(tasks: TaskData[], fromId: string): TaskData[];
/**
* 保存更新后的任务数据到文件
* @param projectDir 项目根目录路径
* @param tasksPath 任务文件相对路径
* @param tasksData 更新后的任务数据
* @returns 成功返回true,失败抛出错误
*/
export declare function saveTasksFile(projectDir: string, tasksPath: string, tasksData: TasksOutput): Promise<boolean>;
/**
* 更新任务的入口函数
* @param projectDir 项目根目录路径
* @param tasksPath 任务文件相对路径
* @param prompt 用于更新任务的提示
* @param fromId 起始任务ID (可以是数字或字符串,如 "1.1" 表示子任务)
* @param openaiUrl OpenAI兼容API的URL
* @param apiKey API密钥
* @param model 模型名称
* @param streamMode 是否使用流式输出
* @returns 更新结果信息
*/
export declare function updateTasks(projectDir: string, tasksPath: string, prompt: string, fromId: number | string, openaiUrl: string, apiKey: string, model: string, streamMode: boolean): Promise<{
saved: boolean;
}>;