golang静态代码分析工具插件库todocheck的使用

Golang静态代码分析工具插件库todocheck的使用

概述

todocheck是一个用于分析带有注释的TODO的静态代码分析工具。它允许你通过将TODO与任何支持的Issue跟踪器中的问题关联起来，创建可操作的TODO。

todocheck logo

工作原理

示例代码：

// TODO J123: Fix this typo
func fuu() {
    ...
}

如果关联的issue J123是开放的，todocheck不会报告任何错误。如果它已关闭或不存在，todocheck会显示错误：

ERROR: Issue is closed.
myproject/main.go:12: // TODO J123: Fix this typo

ERROR: Issue doesn't exist.
myproject/main.go:14: // TODO J321: A non-existent issue

如果代码库中有未注释的TODO，todocheck也会将其报告为格式错误的TODO：

ERROR: Malformed todo.
myproject/main.go:16: // TODO - This is not a valid annotated todo

安装方法

通过Homebrew安装

brew install preslavmihaylov/taps/todocheck

下载预构建二进制文件

从最新版本下载适用于您操作系统的二进制文件。

使用容器

docker run -it -v /path/to/project:/project -e TODOCHECK_AUTH_TOKEN=your_token ghcr.io/preslavmihaylov/todocheck --basepath /project

快速开始

首先，您需要配置todocheck与您的Issue跟踪器的集成。这通过在项目根目录创建.todocheck.yaml文件来完成。

对于公共GitHub或GitLab仓库，您不需要明确指定配置文件，只要您使用Git，todocheck将从Git配置中解释您的Issue跟踪器。

公共GitHub仓库的明确配置如下：

origin: github.com/user/repository
issue_tracker: GITHUB

配置完成后，只需从项目根目录运行todocheck。

支持的Issue跟踪器

Issue跟踪器 描述
Github 支持公共和私有仓库
Gitlab 支持公共和私有仓库
Jira 通过离线令牌和API令牌支持
Pivotal Tracker 通过API令牌支持
Redmine 支持无认证的公开访问和通过API令牌的私有访问
YouTrack 通过API令牌支持
Azure Boards 支持无认证的公开访问和通过API令牌的私有访问

支持的编程语言

todocheck支持多种编程语言的注释格式，包括：

语言 描述
Golang *.go扩展名。支持单行//注释和多行/* */注释
Java *.java扩展名。支持单行//注释和多行/* */注释
JavaScript/Typescript *.js/*.ts扩展名。支持单行//注释和多行/* */注释
Python *.py扩展名。支持单行#注释和多行"""注释
其他 支持C, C++, C#, Dart, Groovy, Kotlin, PHP, R, Rust, Scala, Swift等

完整示例Demo

  1. 创建.todocheck.yaml配置文件：
origin: github.com/yourusername/yourrepo
issue_tracker: GITHUB
auth:
  type: apitoken
ignored:
  - vendor/
  - tests/
custom_todos:
  - "@fix"
  - "FIXME"
  1. 在代码中添加注释的TODO：
// TODO 123: Implement this function
func missingFunction() {
    // TODO 456: Add error handling here
    fmt.Println("This is a placeholder")
    
    // @fix 789: Remove this debug print
    fmt.Println("Debug output")
}
  1. 运行todocheck：
todocheck --basepath .

或者使用JSON输出格式：

todocheck --basepath . --format json
  1. 示例输出（标准格式）：
Checking todos...
No issues found with annotated TODOs.

或者如果发现问题：

ERROR: Issue doesn't exist
main.go:3: // TODO 999: Non-existent issue

配置选项

.todocheck.yaml配置文件中可用的选项：

origin: github.com/user/repository  # 您的远程仓库/Issue跟踪器的源
issue_tracker: GITHUB  # Issue跟踪器类型: GITHUB, GITLAB, JIRA等
ignored:  # todocheck应忽略的目录/文件列表
  - vendor-folder/
  - scripts/*.sh
custom_todos:  # 自定义TODO变量列表
  - "@fix"
  - "FIXME"
auth:  # Issue跟踪器的认证配置
  type: apitoken  # 认证类型: none, offline, apitoken
  offline_url: https://jira.example.com/offline  # 仅当类型为offline时使用
  tokens_cache: ~/.custom_todocheck_tokens.yaml  # 认证令牌缓存位置

认证

对于私有仓库，todocheck需要通过安全提示指定认证令牌。

auth: 
  type: apitoken

您也可以通过环境变量传递认证令牌：

TODOCHECK_AUTH_TOKEN=<your-token> todocheck --basepath .

更多关于golang静态代码分析工具插件库todocheck的使用的实战教程也可以访问 https://www.itying.com/category-94-b0.html

1 回复

更多关于golang静态代码分析工具插件库todocheck的使用的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html


todocheck - Go静态代码分析工具插件库使用指南

todocheck 是一个用于Go代码的静态分析工具，专门用于检查和管理代码中的TODO注释。它可以帮助团队维护代码质量，确保TODO注释被正确跟踪和处理。

安装todocheck

# 使用go install安装
go install github.com/preslavmihaylov/todocheck@latest

# 或者使用brew (macOS)
brew install todocheck

基本使用

1. 简单检查

# 检查当前目录下的Go代码
todocheck .

# 检查指定目录
todocheck ./pkg/...

2. 配置检查规则

创建配置文件 todocheck.yaml：

base: .
auth:
  type: github
  token: $GITHUB_TOKEN
allowed:
  - "TODO(username):"
  - "FIXME(username):"
  - "NOTE:"

3. 集成到CI/CD

在CI流水线中添加检查步骤：

# GitHub Actions示例
name: Todo Check
on: [push, pull_request]
jobs:
  todocheck:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Run todocheck
        run: |
          go install github.com/preslavmihaylov/todocheck@latest
          todocheck .

高级功能

1. 与问题跟踪系统集成

# todocheck.yaml
auth:
  type: github
  token: $GITHUB_TOKEN
  issue_tracker: github
  issue_tracker_params:
    owner: yourorg
    repo: yourrepo

2. 自定义匹配模式

allowed:
  - "TODO(username):"
  - "FIXME(username):"
  - "NOTE:"
  - "OPTIMIZE(username):"

3. 忽略特定文件

ignored:
  - "**/testdata/**"
  - "**/*_test.go"

Go代码示例

以下是一个包含TODO注释的Go文件示例：

package main

import "fmt"

// TODO(john): Implement proper error handling here
func riskyOperation() error {
    return nil
}

// NOTE: This is a temporary workaround
func workaround() {
    fmt.Println("Temporary solution")
}

// FIXME(sarah): This function has performance issues
func slowFunction() {
    // ... implementation ...
}

func main() {
    err := riskyOperation()
    if err != nil {
        fmt.Println("Error:", err)
    }
}

与go vet集成

可以将todocheck与go vet一起使用：

go vet -vettool=$(which todocheck) ./...

常见问题解决

  1. 认证问题：

    • 确保为GitHub等issue跟踪器提供了正确的token
    • Token需要有读取issue的权限

  2. 配置问题：

    • 确保配置文件位于项目根目录
    • 检查YAML格式是否正确

  3. 忽略模式不生效：

    • 确保glob模式语法正确
    • 使用todocheck --verbose查看哪些文件被扫描

最佳实践

  1. 每个TODO注释应该关联一个责任人
  2. 定期运行todocheck清理过期的TODO
  3. 在代码审查中检查TODO注释的合理性
  4. 为TODO注释添加截止日期或issue链接

通过合理使用todocheck，团队可以更好地管理技术债务，提高代码质量。

回到顶部