当前位置:

首页 > 编程开发 > 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 --done、todo 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.Command 的 RunE 字段返回 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 —— 这要求补全路径彻底隔离主流程,有自己的错误降级策略。
    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    WorkBuddy怎么用API接口?有开发文档吗
    WorkBuddy怎么用API接口?有开发文档吗

    WorkBuddy 目前没有面向普通用户的公开 REST API 接口文档,扩展与集成走四条官方路径:接入 MCP 服务扩展工具能力、用连接器打通外部应用(支持公共/个人授权)、编写技能(Skill)与专家包定制工作流、在开放平台发布 Buddy 应用。另支持接入 OpenAI 兼容的自定义模型。本文含 4 张真实界面截图并如实说明现状。

    Google Workspace MCP OAuth 2.0迁移节点已过,旧客户端、普通REST与服务账户分别适用什么规则
    Google Workspace MCP OAuth 2.0迁移节点已过,旧客户端、普通REST与服务账户分别适用什么规则

    解释Google Workspace MCP 11月11日与12日的agentic OAuth客户端迁移节点,区分普通REST应用、混合客户端、预览资格、用户权限和服务账户、Apps Script边界。

    OpenAI Agents SDK v0.24.0-alpha.8升级前为何要备份状态?
    OpenAI Agents SDK v0.24.0-alpha.8升级前为何要备份状态?

    OpenAI Agents SDK v0.24.0-alpha.8预览版新增执行前审批、自有模型客户端、Realtime与预算检查点恢复,说明alpha.7回退、Linux运行及工具认证边界。

    Claude Trading Skills六项诊断修复覆盖哪些密钥泄漏路径?
    Claude Trading Skills六项诊断修复覆盖哪些密钥泄漏路径?

    Claude Trading Skills六项技能已修复API密钥异常日志泄漏路径;not_verified保留完整安全审核缺口,离线回归通过不等于实盘验收或全面认证。

    Microsoft C++ Language Server内置MSBuild提取器后,自动化范围和使用资格怎样理解
    Microsoft C++ Language Server内置MSBuild提取器后,自动化范围和使用资格怎样理解

    解释Microsoft C++ Language Server预览版的MSBuild编译数据库自动提取,区分CMake、自定义构建、有效Copilot订阅和CLI能力,避免把测试预发布版本当最低稳定版。

    LibreOffice宏怎么用?Python脚本能调用吗
    LibreOffice宏怎么用?Python脚本能调用吗

    LibreOffice可通过“工具→宏”创建和运行Basic宏,也支持由Python脚本提供程序运行Python宏。两种方式都可以使用UNO接口操作文档;Excel VBA只有有限兼容支持,不能把所有Excel宏直接复制过来当作LibreOffice原生宏执行。

    GitHub企业Copilot席位API开放应用调用后,读取和席位变更有什么区别
    GitHub企业Copilot席位API开放应用调用后,读取和席位变更有什么区别

    说明Enterprise GitHub Apps的Copilot席位管理权限,提供第一页只读GET示例,区分total_seats、授权明细、遥测活动和待取消计费条件。

    GitHub网页仪表盘默认视图、单行标题和六项列表分别改变什么
    GitHub网页仪表盘默认视图、单行标题和六项列表分别改变什么

    解释GitHub网页仪表盘Feed或Home默认视图、六项列表、自定义选择保留和Agent sessions隐藏条件,区分布局、数据与权限。

    LangChain Python 1.4.10、JS core 1.3.7与langchain 1.6.4为什么要区分拒答和失败
    LangChain Python 1.4.10、JS core 1.3.7与langchain 1.6.4为什么要区分拒答和失败

    核对LangChain三种包版本,解释refusal内容块、ModelRefusalError与中间件传递,提供自定义错误分支示例并区分Python消息流和追踪修复。

    Anthropic Python/Ruby 2.8.0、TS 1.8.0、Go 2.9.0、Java 3.8.0参数校验应如何理解
    Anthropic Python/Ruby 2.8.0、TS 1.8.0、Go 2.9.0、Java 3.8.0参数校验应如何理解

    区分Anthropic各语言SDK及TypeScript云适配包版本,解释Claude Tag字段、Bedrock/Vertex分号差异、非法路径参数和只读Python版本核对。

    查看更多
    精品专题 更多
    装机必备
    装机必备

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

    Windows
    Windows

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

    PDF教程
    PDF教程

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

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。