todo

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 9, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

本文件复刻官方 toTodoList 的值约束(schema 无法表达的部分):trim 后非空、 content 去重、非并行模式下最多一个 in_progress;并提供三态计数。

Package todo 提供 Todo 系统:整体替换写入语义。

对齐上游:packages/core/todo

设计要点:

  • todo/write 每次调用都整体替换当前待办列表(last-write-wins,不做增量 diff);
  • 工具入口 TodoWriteTool 将 LLM 传回的待办列表经 JSON 校验后写入 SessionLog;
  • 读取一律通过 session.FoldTodoWrite 派生,保证热 append 与冷重放一致。

Index

Constants

This section is empty.

Variables

View Source
var ErrDuplicateContent = errors.New("todo: duplicate content")

ErrDuplicateContent 表示存在重复内容。

View Source
var ErrEmptyContent = errors.New("todo: empty content")

ErrEmptyContent 表示存在空白内容条目。

View Source
var ErrMultipleActive = errors.New("todo: more than one in_progress")

ErrMultipleActive 表示非并行模式下出现多个 in_progress。

Functions

This section is empty.

Types

type Counts

type Counts struct {
	Pending    int
	InProgress int
	Completed  int
}

Counts 是三态计数。

func Count

func Count(items []TodoItem) Counts

Count 统计列表三态数量。

type TodoItem

type TodoItem struct {
	// ID 稳定标识(整体替换时用于跨轮跟踪,官方不设;omnix 保留可选)。
	ID string `json:"id,omitempty"`
	// Content 待办内容。
	Content string `json:"content"`
	// Status 三态状态。
	Status TodoStatus `json:"status,omitempty"`
	// Done 是否已完成(两态兼容字段;Status 为空时据此推导)。
	Done bool `json:"done,omitempty"`
}

func Current

func Current(log *session.SessionLog) []TodoItem

Current 返回当前待办列表(通过 fold 派生,last-write-wins),优先三态。

func Normalize

func Normalize(items []TodoItem, allowParallel bool) ([]TodoItem, error)

Normalize 规范化待办列表。

  • trim 后空白内容 → ErrEmptyContent;
  • 重复 content → ErrDuplicateContent;
  • allowParallel=false 时多于一个 in_progress → ErrMultipleActive。

func (TodoItem) ResolvedStatus

func (it TodoItem) ResolvedStatus() TodoStatus

ResolvedStatus 返回有效状态:优先 Status,否则由 Done 推导。

type TodoStatus

type TodoStatus string

TodoItem 是单个待办项。 TodoStatus 是待办三态生命周期(对齐官方 TodoItem.status)。

const (
	StatusPending    TodoStatus = "pending"     // 未开始
	StatusInProgress TodoStatus = "in_progress" // 正在做
	StatusCompleted  TodoStatus = "completed"   // 已完成
)

func (TodoStatus) Valid

func (s TodoStatus) Valid() bool

Valid 返回状态是否为三态之一。

type TodoWriteTool

type TodoWriteTool struct {

	// AllowParallel 是否允许多个 in_progress(默认 false:顺序工作)。
	AllowParallel bool
	// contains filtered or unexported fields
}

TodoWriteTool 是 todo_write 工具定义。

  • 入参为 { items: [{id?, content, done?}] };
  • 调用即整体替换:当前列表被完全覆盖为本次传入的 items;
  • 执行时向 SessionLog 写入一条 todo/write 事件。

func NewTodoWriteTool

func NewTodoWriteTool(sl *session.SessionLog) *TodoWriteTool

NewTodoWriteTool 创建 todo_write 工具。

func (*TodoWriteTool) Description

func (t *TodoWriteTool) Description() string

Description 返回工具描述。

func (*TodoWriteTool) Execute

func (t *TodoWriteTool) Execute(ctx context.Context, input map[string]any) (any, error)

Execute 实现工具执行:整体替换待办列表并写入事件。

func (*TodoWriteTool) Name

func (t *TodoWriteTool) Name() string

Name 返回工具名。

func (*TodoWriteTool) Tool

func (t *TodoWriteTool) Tool() *tools.Tool

TodoTool returns a *tools.Tool wrapper for integration with M23 pipeline.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL