展开菜单
首页 精品内容 本月促销 装机必备 Windows macOS软件 IOS软件 Android AI PDF教程 专题
全部分类

当前位置:

首页 > 编程开发 > Golang实现命令行TODO工具实战教程

Golang实现命令行TODO工具实战教程

因为原生flag包难以维护多子命令、选项解析、帮助生成、补全和错误处理,而spf13/cobra提供自动解析、嵌套命令管理、内置help/alias/short-flag支持及bash/zsh补全。

因为原生 flag 包难以维护多子命令、选项解析、帮助生成、补全和错误处理,而 spf13/cobra 提供自动解析、嵌套命令管理、内置 help/alias/short-flag 支持及 bash/zsh 补全。

如何用Golang实现命令行TODO工具_Golang命令行项目实战

为什么不用 flag 包直接解析,而要用 spf13/cobra

因为 todo add "buy milk"todo list --donetodo rm 3 这类多子命令 + 带选项的 CLI,用原生 flag 写起来很快会失控:参数绑定松散、帮助文本要手写、子命令嵌套难维护、补全和错误提示基本为零。

spf13/cobra 是事实标准,它把每个子命令抽象成 Cobra.Command 实例,自动处理解析、help 生成、别名、短选项合并(如 -d--done),还支持 bash/zsh 补全。

实操建议:

  • cobra-cli 工具初始化项目:cobra-cli init && cobra-cli add add list rm
  • 每个 *cobra.CommandRunE 字段返回 error,Cobra 会自动转成非零退出码和 stderr 输出
  • 避免在 init() 里做 I/O(比如读配置文件),否则单元测试时无法 mock

数据存哪?JSON 文件比 SQLite 更合适

TODO 工具不需要事务、并发写或复杂查询。用 os.WriteFile 存 JSON 到 $HOME/.todo.json,简单、可读、易调试、Git 友好。

常见错误现象:多个终端同时 todo add 导致数据丢失 —— 因为没加文件锁。

实操建议:

  • flock(Linux/macOS)或 syscall.LockFileEx(Windows)对数据文件加写锁,不是靠重命名或临时文件模拟
  • 结构体字段用 json:"id,string" 把 ID 转成字符串,避免前端(比如 TUI)误当数字处理溢出
  • 不要每次操作都 os.ReadFile + json.Unmarshal 全量加载;先 stat 检查文件是否存在,空文件直接用默认切片初始化

todo list --filter=overdue 这种过滤逻辑怎么组织

过滤不是硬编码在 listCmd.RunE 里,而是抽成独立函数,接收原始 []TodoItem*cobra.Command,返回过滤后切片。

这样既方便测试(传入不同数据断言结果),也支持组合过滤:--done --priority=high 就是两个 filter 函数链式调用。

实操建议:

  • 定义 type FilterFunc func([]TodoItem) []TodoItem,每个 flag 对应一个 filter:比如 doneFilter(cmd) 检查 cmd.Flags().GetBool("done")
  • 时间过滤(如 overdue)别用 time.Now().Before(item.Due) 简单比较,要处理 item.Due.IsZero()(无截止时间的 TODO 不参与 overdue 判断)
  • 输出前统一调用 sort.Slice(items, ...),按 ID 升序或状态分组,别依赖存储顺序

如何让 todo 支持 shell 自动补全

Cobra 内置补全生成器,但默认只补子命令(add/list/rm),不补具体数据(比如已存在的 TODO ID 或 tag)。要补 ID,得实现 ValidArgsFunction

容易踩的坑:补全函数里又去读一次 JSON 文件,导致每次按 Tab 都卡顿;或者没处理文件不存在/权限不足,直接 panic。

实操建议:

  • 补全函数必须有超时控制(例如 context.WithTimeout(ctx, 200*time.Millisecond)),超时就退化为只补子命令
  • cmd.RegisterFlagCompletionFunc("id", ...) 给特定 flag 注册补全,而不是全局劫持
  • 生成补全脚本后,提醒用户执行:source <(todo completion bash),别假设他们知道要 reload shell
实际最难的部分不是命令解析或数据存取,是让用户在输入 todo rm 时,能瞬间列出所有可用 ID,且不因磁盘慢、文件损坏或并发写失败而挂住 shell —— 这要求补全路径彻底隔离主流程,有自己的错误降级策略。
本文内容来源于互联网,如有侵权请联系删除。
作者最新文章
编程开发
相关文章 更多
精品专题 更多
本月促销

正软商城本月促销专区,汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动,提供限时折扣、特价授权和优惠购买信息,活动库存及价格以页面实时展示为准。

装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

IOS软件

正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

AI

正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
灵活计算器
灵活计算器

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

赤友清理大师
赤友清理大师

赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

图几
图几

图几是一款适用于 macOS 的截图、标注与美化工具,支持离线操作保障隐私。界面整理和高频系统操作被放到一起考虑,桌面或窗口内容一多时,管理起来会更省心。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Menuist
Menuist

Menuist 是一款面向 macOS 的 Finder 右键菜单增强工具,主要用来补充新建文件、快捷导航等常用操作,让日常文件管理和访问路径时更高效、更顺手。

Mole
Mole

Mole 是一款专为 Mac 设计的深度清理优化工具,涵盖缓存清理、应用管理及实时状态监控等功能。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

WINDOWS 更多
Windows 10
Windows 10

Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

傲梅轻松备份
傲梅轻松备份

傲梅轻松备份是一款专业易用的数据备份软件,为重要数据提供安全保障。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

Wise Folder Hider Pro
Wise Folder Hider Pro

Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件,为私密数据添加多重保护。高频操作更强调就近处理,浏览、整理和跨目录移动文件时,来回切换和重复点击都会少很多。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

PinStack
PinStack

PinStack是一款轻量级的Windows平台剪贴板管理工具,优化您的剪贴板使用体验。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Seer
Seer

Seer是一款在Win平台下的空格键功能增强效率工具,只需轻敲空格键,就能预览几乎任何格式的文件。它更适合把零散的小功能集中起来使用,处理高频琐碎任务时会更省事。