Golang代码注释TODO追踪与管理插件tickgit的使用

tickgit是一个帮助您管理代码库中潜在工作的工具。使用tickgit命令可以查看待处理任务、进度报告、完成摘要和历史数据（使用git历史记录）。

TODOs

tickgit会扫描代码库并识别注释中的任何TODO项。它会输出类似以下的报告：

# tickgit ~/Desktop/facebook/react
...
TODO:
  => packages/scheduler/src/__tests__/SchedulerBrowser-test.js:85:9
  => added 1 month ago by Andrew Clark <git@andrewclark.io> in a2e05b6c148b25590884e8911d4d4acfcb76a487

TODO: Scheduler no longer requires these methods to be polyfilled. But
  => packages/scheduler/src/__tests__/SchedulerBrowser-test.js:77:7
  => added 1 month ago by Andrew Clark <git@andrewclark.io> in a2e05b6c148b25590884e8911d4d4acfcb76a487

TODO: Scheduler no longer requires these methods to be polyfilled. But
  => packages/scheduler/src/forks/SchedulerHostConfig.default.js:77:7
  => added 1 month ago by Andrew Clark <git@andrewclark.io> in a2e05b6c148b25590884e8911d4d4acfcb76a487

TODO: useTransition hook instead.
  => fixtures/concurrent/time-slicing/src/index.js:110:11
  => added 3 weeks ago by Sebastian Markbåge <sebastian@calyptus.eu> in 3ad076472ce9108b9b8a6a6fe039244b74a34392

128 TODOs Found 📝

安装

Homebrew

brew tap augmentable-dev/tickgit
brew install tickgit

使用

最新使用方法可通过运行tickgit --help查看。

示例代码

以下是一个简单的Go代码示例，包含多个TODO注释：

package main

import "fmt"

// TODO: 需要添加更多的错误处理逻辑
func divide(a, b int) (int, error) {
    if b == 0 {
        return 0, fmt.Errorf("cannot divide by zero")
    }
    return a / b, nil
}

// TODO: 实现更高效的计算方式
func calculateSomething(x int) int {
    // FIXME: 这个临时解决方案性能不佳
    result := 0
    for i := 0; i < x; i++ {
        result += i
    }
    return result
}

// HACK: 临时绕过认证检查
func bypassAuthCheck(user string) bool {
    if user == "admin" {
        return true
    }
    return false
}

func main() {
    // TODO: 添加更多的测试用例
    res, err := divide(10, 2)
    if err != nil {
        fmt.Println("Error:", err)
    } else {
        fmt.Println("Result:", res)
    }
}

运行tickgit后，它将检测并报告上述所有TODO、FIXME和HACK注释。

即将推出的功能

• Blame - 更好地了解TODO的创建时间和创建者
• Context - 查看TODO周围的代码以获得更多上下文
• 支持更多TODO类型短语，如FIXME、XXX、HACK或自定义替代项
• 更多配置选项（如自定义忽略路径）
• Markdown解析
• 更全面的历史统计

tickgit不是用来取代JIRA或Trello等完整项目管理工具的，而是希望成为这些工具的补充，提供与代码共存的项目管理模式。它的主要受众是软件工程师。