# バッチ設計書 6-Makefile

## 概要

本ドキュメントは、ビルド・インストール自動化用Makefile `Makefile` の設計仕様を記載する。

### 本バッチの処理概要

このMakefileは、space-vimのインストール、アップデート、アンインストールを簡潔なコマンドで実行できるようにする自動化ツールである。make vim、make neovim、make update、make uninstallの各ターゲットを提供し、手動でコマンドを実行する手間を省く。

**業務上の目的・背景**：space-vimを既にクローン済みのユーザーが、シンプルなmakeコマンドでVim/NeoVimへのインストールや設定の更新を行えるようにする。install.shはリポジトリのクローンから始まるが、Makefileはリポジトリがローカルに存在する前提で、設定ファイルのリンクとプラグインインストールのみを行う軽量なインストール方法を提供する。

**バッチの実行タイミング**：ユーザーが明示的にmakeコマンドを実行する時。初回インストール後の再設定や、特定のエディタ（VimまたはNeoVim）のみへのインストール時に使用。

**主要な処理内容**：
1. make vim - Vim用の設定ファイル作成とプラグインインストール
2. make neovim - NeoVim用の設定ファイル作成とプラグインインストール
3. make update - git pullによるspace-vimの更新
4. make uninstall - 設定ファイルの削除

**前後の処理との関連**：リポジトリがローカルに存在することが前提（git cloneは別途実施済み）。install.shの代替としても使用可能。

**影響範囲**：ユーザーのホームディレクトリ配下のvim設定ファイル（`.vimrc`、`~/.config/nvim/init.vim`、`.spacevim`）に影響を与える。

## バッチ種別

ビルド自動化 / インストール処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動実行（make コマンド） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| make | GNU Makeがインストールされていること |
| git | gitがインストールされていること（updateターゲット用） |
| vim/nvim | 対象エディタがインストールされていること |
| リポジトリ | space-vimリポジトリがローカルに存在すること |

### 実行可否判定

各ターゲットは条件なしで実行される。ファイルが既に存在する場合の処理は `[ ! -f ... ]` 条件で制御される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| ターゲット | 文字列 | Yes | help | 実行するmakeターゲット |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| init.vim | Vim script | space-vim設定ファイル |
| init.spacevim | Vim script | ユーザー設定テンプレート |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ~/.vimrc | シンボリックリンク | Vim用設定ファイル（vimターゲット） |
| ~/.config/nvim/init.vim | シンボリックリンク | NeoVim用設定ファイル（neovimターゲット） |
| ~/.spacevim | ファイル | ユーザー設定ファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | .vimrc / init.vim / .spacevim |
| 出力先 | ユーザーホームディレクトリ配下 |
| 文字コード | UTF-8 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス（各ターゲット）

#### make help
```
1. 使用方法を表示
```

#### make vim
```
1. インストール開始メッセージ表示
2. .vimrc が存在しない場合、シンボリックリンク作成
3. .spacevim が存在しない場合、init.spacevimをコピー
4. vim +PlugInstall +qall でプラグインインストール
5. 完了メッセージ表示
```

#### make neovim
```
1. インストール開始メッセージ表示
2. ~/.config/nvim ディレクトリ作成
3. nvim/init.vim が存在しない場合、シンボリックリンク作成
4. .spacevim が存在しない場合、init.spacevimをコピー
5. nvim +PlugInstall +qall でプラグインインストール
6. 完了メッセージ表示
```

#### make update
```
1. 更新開始メッセージ表示
2. git pull origin master 実行
3. 完了メッセージ表示
```

#### make uninstall
```
1. アンインストール開始メッセージ表示
2. .vimrc 削除
3. nvim/init.vim 削除
4. .spacevim 削除
5. 完了メッセージ表示
```

### フローチャート

```mermaid
flowchart TD
    A[make 実行] --> B{ターゲット?}
    B -->|help| C[使用方法表示]
    B -->|vim| D[Vimインストール処理]
    B -->|neovim| E[NeoVimインストール処理]
    B -->|update| F[git pull実行]
    B -->|uninstall| G[設定ファイル削除]

    D --> D1{.vimrc存在?}
    D1 -->|No| D2[シンボリックリンク作成]
    D1 -->|Yes| D3{.spacevim存在?}
    D2 --> D3
    D3 -->|No| D4[init.spacevimコピー]
    D3 -->|Yes| D5[PlugInstall実行]
    D4 --> D5
    D5 --> D6[完了]

    E --> E1[nvimディレクトリ作成]
    E1 --> E2{init.vim存在?}
    E2 -->|No| E3[シンボリックリンク作成]
    E2 -->|Yes| E4{.spacevim存在?}
    E3 --> E4
    E4 -->|No| E5[init.spacevimコピー]
    E4 -->|Yes| E6[PlugInstall実行]
    E5 --> E6
    E6 --> E7[完了]
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | 本バッチはデータベースを使用しない |

### テーブル別操作詳細

N/A - データベース操作なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ターゲットエラー | 不明なターゲットが指定された | make helpで使用方法を確認 |
| - | 権限エラー | ファイル作成権限がない | 適切な権限を確認 |
| - | ネットワークエラー | git pullが失敗 | ネットワーク接続を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

- コマンド失敗時は手動で該当処理を実行する
- PlugInstall失敗時はvim/nvimを起動して手動でインストール

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回/実行 |
| 目標処理時間 | 数秒〜数分（プラグインインストール時） |
| メモリ使用量上限 | vim/nvim実行時のメモリ使用量 |

## 排他制御

同時実行の想定なし。複数のターゲットを並行実行した場合、ファイル操作で競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 各ターゲット実行開始時 | "==> Trying to install/update/uninstall space-vim" |
| 進捗ログ | ファイル操作完了時 | "- Created ~/.vimrc" 等 |
| 完了ログ | 処理完了時 | "[✔] Successfully installed/updated/uninstalled space-vim" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（手動実行のため監視対象外） |

## 備考

- .PHONYディレクティブによりhelp, vim, neovim, update, uninstallは擬似ターゲットとして定義
- PWD変数は $(shell pwd) で現在のディレクトリを取得
- ln -sf オプションにより既存ファイルを上書きしてシンボリックリンクを作成
- init.spacevimのコピーは既存ファイルがない場合のみ実行される（ユーザー設定を保護）
- カラー出力（\033[1;34m, \033[32m）を使用してメッセージを見やすく表示
- uninstallターゲットは~/.space-vimディレクトリ自体は削除しない（install.shと異なる動作）
