開発者ガイド

このドキュメントは、esa-cliの開発者向けのガイドです。 プロジェクトの構造、開発環境のセットアップ、ビルド方法などを説明します。

📁 プロジェクト構造

esa-cli/
├── cmd/
│   └── esa-cli/        # メインのCLIアプリケーション
├── internal/
│   ├── api/           # esa APIクライアント
│   ├── config/        # 設定管理
│   ├── mac/           # Mac向け機能
│   └── markdown/      # Markdown処理
├── pkg/
│   └── types/         # 共通型定義
├── docs/              # ドキュメント
├── scripts/           # ビルド・インストールスクリプト
├── Formula/           # Homebrew Formula
├── go.mod             # Goモジュール定義
└── README.md         # プロジェクト概要

🔧 開発環境のセットアップ

必要条件

• Go 1.16以上
• Git
• Make（オプション）

セットアップ手順

1. リポジトリのクローン

git clone https://github.com/shellme/esa-cli.git
cd esa-cli

2. 依存関係のインストール

go mod download

3. 開発用ビルド

go build -o esa-cli cmd/esa-cli/main.go

🏗 ビルド方法

ローカルビルド

# 開発用ビルド
go build -o esa-cli cmd/esa-cli/main.go

# リリース用ビルド（最適化）
go build -ldflags="-s -w" -o esa-cli cmd/esa-cli/main.go

クロスコンパイル

# Mac用（Intel）
GOOS=darwin GOARCH=amd64 go build -o esa-cli-darwin-amd64 cmd/esa-cli/main.go

# Mac用（Apple Silicon）
GOOS=darwin GOARCH=arm64 go build -o esa-cli-darwin-arm64 cmd/esa-cli/main.go

🧪 テスト

ユニットテスト

# 全テストの実行
go test ./...

# 特定のパッケージのテスト
go test ./internal/api/...

インテグレーションテスト

# インテグレーションテストの実行
go test -tags=integration ./...

📝 コーディング規約

• Effective Go に従う
• エラーハンドリングは適切に行う
• テストカバレッジを維持する
• ドキュメントコメントを書く

🔍 デバッグ

ログ出力

import "log"

// デバッグログ
log.Printf("Debug: %v", value)

// エラーログ
log.Printf("Error: %v", err)

環境変数

# デバッグモードの有効化
export ESA_CLI_DEBUG=1

# ログレベルの設定
export ESA_CLI_LOG_LEVEL=debug

🚀 新機能の追加

1. 機能の提案

   • Issueの作成
   • 設計のレビュー

2. 実装

   • ブランチの作成
   • コードの実装
   • テストの追加

3. レビュー

   • プルリクエストの作成
   • コードレビュー
   • テストの実行

4. マージ

   • レビュー後のマージ
   • リリース準備

📦 リリース手順

1. バージョン番号の更新

   • Formula/esa-cli.rb のバージョン番号を更新
   • 必要に応じて go.mod のバージョンも更新

2. バイナリのビルド

# リリース用バイナリのビルド
make release

3. GitHubリリースの作成

   • タグの作成とプッシュ
   • リリースノートの作成
   • バイナリのアップロード

4. Homebrew Formulaの更新

   • SHA256値の更新
   • 必要に応じて依存関係の更新

🔧 トラブルシューティング

よくある問題

1. ビルドエラー

   • 依存関係の確認
   • Goのバージョン確認

2. テストの失敗

   • テスト環境の確認
   • モックの設定確認

3. 依存関係の問題

   • go mod tidy の実行
   • 依存関係のバージョン確認

📚 参考資料

• Go公式ドキュメント
• esa APIドキュメント
• Homebrew Formula Cookbook