Go リンティング

コア原則

「推奨」されるリンターセットより重要なこと: コードベース全体で一貫してリンティングを行うこと。

一貫したリンティングは一般的な問題をキャッチし、不必要に規範的にならずにコード品質の高い基準を確立するのに役立ちます。

---

セットアップ手順

1. 以下の設定を使用して .golangci.yml を作成
2. golangci-lint run ./... を実行
3. エラーが表示された場合は、カテゴリごとに修正 (フォーマット、vet、スタイルの順)
4. クリーンになるまで再実行

---

最小推奨リンター

これらのリンターは、高い品質基準を維持しながら最も一般的な問題をキャッチします:

リンター	目的
errcheck	エラーが処理されていることを確認
goimports	コードをフォーマット、インポートを管理
revive	一般的なスタイルエラー (廃止された golint の最新の代替品)
govet	コードの一般的な間違いを分析
staticcheck	様々な静的解析チェック

注釈: revive は廃止予定の golint の最新で、より高速な後継です。

---

リンターランナー: golangci-lint

リンターランナーとして golangci-lint を使用します。uber-go/guide のサンプル .golangci.yml を参照してください。

---

設定例

新しい .golangci.yml を作成する場合、または既存の設定を推奨される基準と比較する場合は、assets/golangci.yml を参照してください。

プロジェクトルートに .golangci.yml を作成します:

linters:
  enable:
    - errcheck
    - goimports
    - revive
    - govet
    - staticcheck

linters-settings:
  goimports:
    local-prefixes: github.com/your-org/your-repo
  revive:
    rules:
      - name: blank-imports
      - name: context-as-argument
      - name: error-return
      - name: error-strings
      - name: exported

run:
  timeout: 5m

実行方法

# インストール
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

# すべてのリンターを実行
golangci-lint run

# 特定のパスで実行
golangci-lint run ./pkg/...

---

追加の推奨リンター

最小セットを超えて、本番プロジェクトでは以下を検討してください:

リンター	目的	有効にする時機
gosec	セキュリティ脆弱性の検出	ユーザー入力を処理するサービスの場合は常に
ineffassign	無効な代入を検出	常に - デッドコードをキャッチ
misspell	コメント/文字列の一般的なスペルミスを修正	常に
gocyclo	循環的複雑度のしきい値	関数の複雑度が ~15 を超える場合
exhaustive	スイッチがすべての列挙値をカバーしていることを確認	iota 列挙を使用する場合
bodyclose	閉じられない HTTP レスポンスボディを検出	HTTP クライアントコードでは常に

---

Nolint ディレクティブ

リント検出を抑制する場合は、常に理由を説明してください:

//nolint:errcheck // fire-and-forget logging; error is not actionable
_ = logger.Sync()

ルール:

• //nolint:lintername を使用 - 素の //nolint は禁止
• コメントを検出と同じ行に配置
• // の後に正当性を含める

---

CI/CD 統合

GitHub Actions

# .github/workflows/lint.yml
name: Lint
on: [push, pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version: stable
      - uses: golangci/golangci-lint-action@v6
        with:
          version: latest

Pre-commit フック

#!/bin/sh
# .git/hooks/pre-commit
golangci-lint run --new-from-rev=HEAD~1

--new-from-rev を使用して変更されたコードのみをリント処理し、フィードバックループを高速に保ちます。

---

利用可能なスクリプト

• scripts/setup-lint.sh — .golangci.yml を生成し、初期リントを実行

bash scripts/setup-lint.sh github.com/your-org/your-repo
bash scripts/setup-lint.sh --force github.com/your-org/your-repo  # 既存を上書き
bash scripts/setup-lint.sh --dry-run                               # 設定をプレビュー
bash scripts/setup-lint.sh --json                                  # 構造化出力

検証: .golangci.yml を生成した後、golangci-lint run ./... を実行して、設定が有効で期待された出力を生成することを確認します。設定エラーで失敗した場合は修正して再試行します。

scripts/setup-lint.sh は最小限の設定 (5 つのコアリンター) を生成します。 確立されたプロジェクトの場合は、assets/golangci.yml を出発点として使用してください — gosec、ineffassign、misspell、gocyclo、bodyclose を追加します。

---

クイックリファレンス

タスク	コマンド/アクション
golangci-lint をインストール	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
リンターを実行	golangci-lint run
パスで実行	golangci-lint run ./pkg/...
設定ファイル	プロジェクトルートの .golangci.yml
CI 統合	パイプラインで golangci-lint run を実行
Nolint ディレクティブ	//nolint:name // reason - 素の //nolint は禁止
CI 統合	GitHub Actions には golangci/golangci-lint-action を使用
Pre-commit	golangci-lint run --new-from-rev=HEAD~1

リンター選択ガイドライン

必要な場合...	使用
エラーハンドリングカバレッジ	errcheck
インポートフォーマット	goimports
スタイルの一貫性	revive
バグ検出	govet、staticcheck
上記すべて	設定付き golangci-lint

---

関連スキル

• スタイルの基礎: リンターが適用するスタイル質問 (フォーマット、ネスト、命名) を解決する際は go-style-core を参照
• コードレビュー: リンター出力と手動レビューチェックリストを組み合わせる場合は go-code-review を参照
• エラーハンドリング: errcheck が未処理エラーにフラグを立てたときに、それらを処理する方法を決定する必要がある場合は go-error-handling を参照
• テスト: CI パイプラインでリンターをテストと一緒に実行する場合は go-testing を参照