Goプログラミングの世界において、コードの読みやすさと一貫性は極めて重要な要素です。

多人数での開発やオープンソースプロジェクトにおいて、インデントや改行のスタイルで議論が紛糾することは珍しくありません。

Go言語はこの「スタイル論争」に終止符を打つべく、公式に標準フォーマッタであるgo fmtを提供しています。

「Gofmt’s style is no one’s favorite, yet gofmt is everyone’s favorite（gofmtのスタイルが誰にとっても最高というわけではないが、gofmtは誰にとってもお気に入りである）」という言葉がある通り、個人の好みを排除し、言語標準のスタイルを強制することでチーム全体の生産性を劇的に向上させることができます。

本記事では、基本的な使い方から、高度なツールとの連携、そしてCI/CDパイプラインへの組み込み方法まで、現場で役立つ実践的な知識を詳しく解説します。

目次 [ close ]
  1. Go言語におけるコード整形の哲学
    1. スタイル論争の排除と可読性の向上
    2. ツールチェーンの一部としての重要性
  2. go fmtの基本操作とgofmtとの違い
    1. 基本的な実行方法
    2. go fmt と gofmt の使い分け
  3. 開発環境（IDE）との連携による効率化
    1. VS Code (Visual Studio Code)
    2. JetBrains GoLand
  4. さらに高度な整形ツール：goimportsとgofumpt
    1. goimports によるインポート管理
    2. gofumpt による厳格なフォーマット
  5. CI/CDパイプラインでの自動チェック
    1. GitHub Actions での構成例
    2. golangci-lint の活用
  6. 実践的なTipsとよくある質問
    1. タブ vs スペース問題
    2. 特定の箇所だけフォーマットを無効にできるか？
    3. コメントの整形
  7. まとめ

Go言語におけるコード整形の哲学

Go言語が誕生した当初から、開発チームは「一貫したコードスタイル」の重要性を強調してきました。

多くのプログラミング言語では、インデントにタブを使うかスペースを使うか、あるいは波括弧をどこに置くかといった議論に多くの時間が費やされてきました。

しかし、Go言語では「標準ツールが生成するスタイルこそが正解」という明確な基準があります。

スタイル論争の排除と可読性の向上

go fmtを利用する最大のメリットは、コードレビューにおいてロジックの本質に集中できる点にあります。

スタイルが統一されていないプロジェクトでは、差分（diff）に本質的ではない整形の変更が混じり、修正内容の把握を妨げることがあります。

すべてのGoエンジニアが同じツールで整形を行うことで、誰が書いたコードであっても同じ感覚で読み進めることが可能になります。これは、プロジェクトのメンテナンス性を長期的に維持する上で欠かせない要素です。

ツールチェーンの一部としての重要性

Goのツールチェーンは、go buildやgo test、そしてgo fmtが密接に連携するように設計されています。

公式ドキュメントや標準ライブラリのソースコードもすべてこのフォーマッタに従って記述されており、エコシステム全体で一貫性が保たれています。

go fmtの基本操作とgofmtとの違い

日常的な開発で頻繁に使用するのはgo fmtコマンドですが、その背後にはgofmt（goを付けない形式）という低レイヤーのツールが存在します。

基本的な実行方法

最もシンプルな使い方は、ファイル名を指定して実行する方法です。

go
// 整形前のコード (bad.go)
package main
import "fmt"
func main() {
    fmt.Println("Hello, World")
    if true {
    fmt.Println("Indentation error")
    }
}

このファイルを整形するには、以下のコマンドをターミナルで実行します。

Shell
go fmt bad.go

実行後、ファイルは以下のように自動的に修正されます。

go
// 整形後のコード (bad.go)
package main

import "fmt"

func main() {
	fmt.Println("Hello, World")
	if true {
		fmt.Println("Indentation error")
	}
}

プロジェクト全体を一度に整形したい場合は、ディレクトリを指定するか、再帰的なワイルドカードを使用します。

Shell
# カレントディレクトリとそのサブディレクトリ以下のすべてのファイルを整形
go fmt ./...

go fmt と gofmt の使い分け

go fmtは内部的にgofmt -l -wを呼び出すラッパーコマンドです。

一般的にはgo fmtを使えば十分ですが、より細かい制御が必要な場合はgofmtを直接使用します。

コマンド主な用途特徴
go fmt日常的な開発シンプルで使いやすく、ファイルを直接上書きする
gofmt -d差分の確認ファイルを書き換えずに、整形が必要な箇所をdiff形式で出力する
gofmt -sコードの簡略化スライスの初期化など、冗長な記述を短縮化する
gofmt -r書き換え規則特定のパターンに基づいてコードをルールベースで置換する

注意点として、go fmtはデフォルトでファイルを上書きします。もし上書きせずにチェックだけを行いたい場合は、後述するCI/CDのセクションで紹介するオプションを使用してください。

開発環境（IDE）との連携による効率化

手動でコマンドを打つのは手間がかかるため、現代のGo開発ではエディタの保存時に自動で整形を行うのが一般的です。

VS Code (Visual Studio Code)

VS CodeでGo開発を行う場合、「Go」拡張機能（Go Team at Google提供）をインストールします。

この拡張機能はデフォルトでgopls（言語サーバー）を使用し、保存時のフォーマットをサポートしています。

settings.jsonに以下の設定が含まれているか確認してください。

JSON
{
    "[go]": {
        "editor.formatOnSave": true,
        "editor.codeActionsOnSave": {
            "source.organizeImports": "explicit"
        }
    }
}

この設定により、ファイルを保存するたびに自動でコードが整形され、未使用のインポート文も削除されます。

JetBrains GoLand

GoLandは最初から強力なフォーマット機能を備えています。

設定の「Tools」→「File Watchers」から「go fmt」を有効にすることで、保存時にバックグラウンドで実行させることが可能です。

また、標準設定でもコードの編集を終えるタイミングで適切にインデントが調整されます。

さらに高度な整形ツール：goimportsとgofumpt

標準のgo fmtだけでは満足できないケースもあります。

特にインポートの整理や、より厳格なルールを適用したい場合に以下のツールが役立ちます。

goimports によるインポート管理

標準のgo fmtはコードの見た目を整えますが、インポート文の追加や削除までは行いません。

これを解決するのがgoimportsです。

Shell
# インストール
go install golang.org/x/tools/cmd/goimports@latest

# 実行
goimports -w main.go

goimportsはgo fmtの機能に加え、標準ライブラリとサードパーティライブラリをグループ分けして整理する機能も持っています。

gofumpt による厳格なフォーマット

gofumptは、標準のgofmtよりも厳格なルールを適用するフォーマッタです。

よりクリーンなコードを好むコミュニティや企業で採用されることが増えています。

  • 割り当て記号（:=）の周囲の空行の制御
  • 冗長な型宣言の削除の強化
Shell
# インストール
go install mvdan.cc/gofumpt@latest

# 実行
gofumpt -l -w .

「チーム内でより統一感を高めたい」という場合には、gofumptの導入を検討すると良いでしょう。

CI/CDパイプラインでの自動チェック

ローカル環境で整形を忘れてコミットしてしまうミスを防ぐために、CI（継続的インテグレーション）プロセスでフォーマットのチェックを自動化することが不可欠です。

GitHub Actions での構成例

GitHub Actionsを使用して、プルリクエスト時にコードが整形されているかを確認するワークフローの例を紹介します。

YAML
name: Go Format Check

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  fmt:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.24'

      - name: Check formatting
        run: |
          # 整形が必要なファイルがあるか確認し、あればリストアップして終了ステータス1を返す
          if [ -n "$(gofmt -l .)" ]; then
            echo "The following files are not formatted:"
            gofmt -l .
            exit 1
          fi

このスクリプトのポイントは、gofmt -l .を使用している点です。

-lオプションは「整形が必要なファイル名のみを出力する」ため、出力が空でない場合にエラーとして処理することで、未整形のコードがリポジトリに混入するのを防ぎます。

golangci-lint の活用

より本格的なプロジェクトでは、フォーマットチェックだけでなく静的解析（Linter）をまとめて実行できるgolangci-lintの使用を推奨します。

.golangci.yml という設定ファイルを作成し、gofmtやgoimportsを有効にすることで、一つのコマンドで一括チェックが可能です。

YAML
# .golangci.yml の例
linters:
  enable:
    - gofmt
    - goimports
    - misspell

実践的なTipsとよくある質問

タブ vs スペース問題

Go言語では、インデントには必ずタブ（Tab）を使用します。これは言語設計者による決定であり、個人の設定で変更することは推奨されません。

ただし、表示上の幅（Tab Width）はエディタ側で自由に変更しても問題ありません（一般的には 4 または 8 が使われます）。

一方、コード内の位置合わせ（Alignment）にはスペースが使われることもありますが、これらはすべてgo fmtが自動的に判断します。

特定の箇所だけフォーマットを無効にできるか？

他の言語（JavaScriptのPrettierなど）では特定のコメントでフォーマットを無視する機能がありますが、Goの標準フォーマッタには特定の行をスキップする機能はありません。

これは「例外を認めない」というGoの強い設計思想の表れです。

もし行列計算のコードなどで、どうしても独自の整列を維持したい場合は、その部分だけ別ファイルに切り出し、ビルドタグで管理するなどの工夫が必要になります。

しかし、基本的には「ツールに従う」のがGoの最も正しい作法です。

コメントの整形

go fmtはコメント自体の文章を修正することはありませんが、コメントの開始位置やインデントは調整します。

特に構造体のフィールドに対するコメントなどは、綺麗に縦一列に並ぶように整形されます。

go
type User struct {
    ID   int    // ユーザーID
    Name string // ユーザー名
    Age  int    // 年齢
}

上記のように、コメントの開始位置が揃うことで、構造体の定義が非常に見やすくなります。

まとめ

Go言語のgo fmtは、単なる整形ツール以上の役割を担っています。

それは、開発者が無駄な議論に費やす時間を削り、プロジェクト全体のコード品質を一定に保つための「共通言語」としての役割です。

本記事で解説した内容を振り返ります。

  • 基本： go fmt ./... を活用してプロジェクト全体を常にクリーンに保つ。
  • 効率化： IDEの「Save on Format」を有効にし、意識せずに整形される環境を作る。
  • 拡張： goimportsやgofumptを組み合わせて、さらに一貫性を高める。
  • 自動化： CI/CDパイプラインにチェック工程を組み込み、チーム全体での品質を担保する。

コード整形をツールに任せることで、私たちはより本質的な「ロジックの構築」や「アーキテクチャの設計」に集中できるようになります。

もしまだ手動で整形を行っているなら、今日から自動化の第一歩を踏み出してみましょう。

Goのツールチェーンが提供する恩恵を最大限に享受することが、プロフェッショナルなGoエンジニアへの近道です。