Golang实现Git无缝轻量级时间追踪插件git-time-metric

Git-time-metric (GTM)是一个轻量级的时间追踪工具，可以无缝集成到Git工作流中，帮助开发者记录在代码上花费的时间。下面我将介绍如何使用Golang实现类似功能。

核心功能设计

1. 自动记录文件编辑时间
2. 与Git提交关联
3. 生成时间报告
4. 轻量级无侵入集成

Golang实现方案

1. 基本数据结构

package gtm

import (
	"time"
)

// TimeRecord 表示单个文件的时间记录
type TimeRecord struct {
	FilePath    string        `json:"file_path"`
	ActiveTime  time.Duration `json:"active_time"`
	LastUpdated time.Time     `json:"last_updated"`
}

// CommitRecord 表示提交关联的时间记录
type CommitRecord struct {
	CommitHash string       `json:"commit_hash"`
	Records    []TimeRecord `json:"records"`
	Timestamp  time.Time    `json:"timestamp"`
}

2. 文件监视器实现

package gtm

import (
	"os"
	"path/filepath"
	"time"
)

type FileWatcher struct {
	activeFiles map[string]*TimeRecord
	dataDir     string
}

func NewFileWatcher(dataDir string) *FileWatcher {
	return &FileWatcher{
		activeFiles: make(map[string]*TimeRecord),
		dataDir:     dataDir,
	}
}

func (fw *FileWatcher) StartWatching() {
	// 实现文件系统监视逻辑
	// 可以使用fsnotify库来监视文件变化
}

func (fw *FileWatcher) recordActivity(filePath string) {
	now := time.Now()
	
	if record, exists := fw.activeFiles[filePath]; exists {
		// 更新现有记录
		record.ActiveTime += now.Sub(record.LastUpdated)
		record.LastUpdated = now
	} else {
		// 创建新记录
		fw.activeFiles[filePath] = &TimeRecord{
			FilePath:    filePath,
			ActiveTime:  0,
			LastUpdated: now,
		}
	}
}

3. Git钩子集成

package gtm

import (
	"fmt"
	"os"
	"os/exec"
	"path/filepath"
)

func InstallGitHooks(repoPath string) error {
	hookContent := `#!/bin/sh
gtm pre-commit
`

	hookPath := filepath.Join(repoPath, ".git", "hooks", "pre-commit")
	if err := os.WriteFile(hookPath, []byte(hookContent), 0755); err != nil {
		return fmt.Errorf("failed to install pre-commit hook: %v", err)
	}
	return nil
}

func PreCommitHook() error {
	// 在提交前记录时间数据
	// 获取暂存区文件列表
	cmd := exec.Command("git", "diff", "--name-only", "--cached")
	output, err := cmd.Output()
	if err != nil {
		return err
	}
	
	// 处理文件列表并记录时间
	// ...
	
	return nil
}

4. 命令行接口

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/urfave/cli/v2"
)

func main() {
	app := &cli.App{
		Name:  "gtm",
		Usage: "Git Time Metric - lightweight time tracking for Git",
		Commands: []*cli.Command{
			{
				Name:  "init",
				Usage: "Initialize GTM in the current repository",
				Action: func(c *cli.Context) error {
					// 初始化逻辑
					return nil
				},
			},
			{
				Name:  "status",
				Usage: "Show current time tracking status",
				Action: func(c *cli.Context) error {
					// 显示状态逻辑
					return nil
				},
			},
			{
				Name:  "report",
				Usage: "Generate time tracking report",
				Flags: []cli.Flag{
					&cli.StringFlag{
						Name:  "format",
						Value: "text",
						Usage: "Report format (text, json, csv)",
					},
				},
				Action: func(c *cli.Context) error {
					// 生成报告逻辑
					return nil
				},
			},
		},
	}

	if err := app.Run(os.Args); err != nil {
		log.Fatal(err)
	}
}

使用示例

1. 初始化GTM

$ gtm init
GTM initialized in current repository.
Git hooks installed successfully.

1. 正常工作（自动记录时间）

2. 查看状态

$ gtm status
File                   Active Time
src/main.go           1h 23m
src/utils.go          45m

1. 生成报告

$ gtm report --format=csv
file,time
src/main.go,1.38
src/utils.go,0.75

实现注意事项

1. 性能考虑：文件监视要轻量级，避免影响开发体验
2. 数据存储：使用简单的JSON文件存储时间数据
3. Git集成：通过Git钩子自动触发时间记录
4. 跨平台：确保在Windows、macOS和Linux上都能工作
5. 配置选项：允许用户排除某些文件或目录

扩展功能

1. IDE插件集成
2. 团队时间统计
3. 与项目管理工具(JIRA等)集成
4. 可视化报告

这个实现提供了GTM的核心功能框架，你可以根据需要进一步扩展和完善。关键是要保持轻量级和无缝集成的特点，避免给开发者带来额外负担。