如何在golangci-lint私有插件中获取正确的Token位置

要让自定义插件准确报告go.mod中违规依赖的位置，核心是为go.mod文件单独创建并关联token.FileSet，避免和Golangci-lint默认的源码FileSet混淆。以下是具体实现步骤：

关键问题分析 #

你之前的错误在于直接使用req.Syntax.Start.Byte转换位置时，复用了Golangci-lint默认的token.FileSet——这个FileSet只包含项目的Go源码文件（如logging/gcp.go），并没有关联go.mod，导致位置映射到了无关文件。

正确实现步骤 #

1. 定位并读取go.mod文件
   通过Golangci-lint的上下文获取项目根目录，拼接出go.mod的完整路径，读取文件内容。

2. 为go.mod创建独立的token.FileSet
   新建一个token.FileSet，将go.mod文件添加进去，确保后续解析的语法节点位置能正确映射到该文件。

3. 关联FileSet解析go.mod
   使用modfile.ParseWithOptions（或modfile.Parse）解析go.mod时，传入刚才创建的FileSet，让解析后的语法节点关联正确的文件位置。

4. 转换并使用正确的位置
   从依赖项的Syntax.Start.Byte转换为token.Pos，用这个位置生成问题报告。

代码示例 #

import (
    "os"
    "path/filepath"
    "fmt"
    "go/token"
    "golang.org/x/mod/modfile"
    "github.com/golangci/golangci-lint/pkg/lintcontext"
    "github.com/golangci/golangci-lint/pkg/lintutils"
)

type WhitelistLinter struct{}

func (l *WhitelistLinter) Name() string {
    return "dependency-whitelist"
}

func (l *WhitelistLinter) Run(lc *lintcontext.LintContext) error {
    // 获取项目根目录下的go.mod路径
    modFilePath := filepath.Join(lc.Cfg.Run.Dir, "go.mod")
    modContent, err := os.ReadFile(modFilePath)
    if err != nil {
        return fmt.Errorf("failed to read go.mod: %w", err)
    }

    // 为go.mod创建独立的FileSet
    fs := token.NewFileSet()
    // 将go.mod添加到FileSet，指定文件名、起始位置和文件长度
    modFileToken := fs.AddFile(modFilePath, fs.Base(), len(modContent))

    // 解析go.mod并关联FileSet
    parsedMod, err := modfile.Parse(modFilePath, modContent, &modfile.ParseOptions{
        FileSet: fs,
    })
    if err != nil {
        return fmt.Errorf("failed to parse go.mod: %w", err)
    }

    // 定义你的依赖白名单
    whitelist := map[string]bool{
        "github.com/golang/glog": true,
        "golang.org/x/net": true,
        // 其他白名单依赖
    }

    // 遍历所有依赖检查
    for _, req := range parsedMod.Require {
        depPath := req.Mod.Path
        if !whitelist[depPath] {
            // 将Syntax的字节偏移转换为正确的token.Pos
            issuePos := modFileToken.Pos(req.Syntax.Start.Byte)
            // 报告违规问题
            lc.ReportIssue(lintutils.Issue{
                Pos:        issuePos,
                Text:       fmt.Sprintf("依赖 %q 不在白名单内", depPath),
                Severity:   lintutils.SeverityError,
                FromLinter: l.Name(),
            })
        }
    }

    return nil
}

注意事项 #

• 如果是多模块项目，需要遍历每个模块的go.mod文件，重复上述逻辑。
• 确保golang.org/x/mod依赖已正确引入，版本建议使用较新的稳定版。

内容的提问来源于stack exchange，提问作者Avag Sargsyan