go.modフォーマットのベストプラクティス

go.modフォーマットのベストプラクティス

一貫したフォーマット規約に従うことで、go.modファイルが読みやすく、保守しやすく、マージしやすくなります。

標準フォーマット

Goツールチェーンは標準的なgo.modフォーマットを定義しています：

module github.com/example/project

go 1.22.0

require (
    github.com/gin-gonic/gin v1.9.1
    github.com/spf13/cobra   v1.8.0
    golang.org/x/text        v0.14.0
)

require (
    github.com/bytedance/sonic v1.10.0 // indirect
    golang.org/x/crypto       v0.17.0 // indirect
)

主要な規約

1. タブインデント: ブロック内のエントリは単一タブ
2. バージョン整列: バージョン番号は同じ列に整列
3. ブロック構成: module → go → 直接require → 間接require → replace → exclude → retract
4. 空行: 各ブロック間に1行の空行
5. アルファベット順ソート: 各ブロック内のエントリをモジュールパスでソート

CI統合

CIパイプラインでフォーマットチェックを追加：

- name: Check go.mod formatting
  run: |
    go mod tidy
    git diff --exit-code go.mod go.sum