開発ガイド

kvtool の開発に参加する方向けのガイドです。

開発環境のセットアップ

必要なツール

Go 1.21 以上
Make
Docker（統合テスト用）

テスト実行

# 全テスト実行
make test

# Vault含む統合テスト
make test-full

テスト用サービスの起動

# 全サービス起動（Vault + MinIO）
make services-up
# Vault: http://localhost:8200 (token: root)
# MinIO: http://localhost:9000 (user: minioadmin)

# 全サービス停止
make services-down

# ログ確認
make services-logs

コード規約

詳細は CLAUDE.md を参照してください。

テスト規約

テーブル駆動テスト: 全てのテストはテーブル駆動テストで記述
日本語: テスト名、コメント、エラーメッセージは日本語で記述

セキュリティ規約

パストラバーサル防止: 全てのファイルシステムは root より上位に遡れないようにする
相対パスのみ: 絶対パス（/etc/passwd）やチルダパス（~/config）は拒否

ドキュメント生成

# APIリファレンスを自動生成
make doc-gen

コード内のコメントと構造体タグから docs/api-reference.md が自動生成されます。

コード品質

# 静的解析
make lint

# コードフォーマット
make format

# 品質分析（カバレッジ + 複雑度）
make test-quality

# 開発ツールのインストール（golangci-lint）
make setup-tools

新しいファイルシステムドライバーの追加

仕様策定: do../pkg/filesystems/{driver}.md を作成
構造体定義: 設定構造体を定義（doc, required, default, example タグを含む）
インターフェース実装: Filesystem と File インターフェースを実装
テスト: filesystems/integration_test.go にテストケースを追加
ドキュメント生成: make doc-gen を実行

詳細は CLAUDE.md の「開発ワークフロー」セクションを参照してください。