# バッチ設計書 2-install.cmd

## 概要

本ドキュメントは、space-vimのWindows向けインストールスクリプト `install.cmd` の設計仕様を記載する。

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

このバッチは、space-vim（Spacemacsにインスパイアされたモダンなvimディストリビューション）をWindows環境にインストールするためのバッチファイルである。PowerShell経由で実行され、必要な依存関係の確認、リポジトリのクローン、vim-plugのダウンロード、設定ファイルの配置を自動化する。

**業務上の目的・背景**：Windowsユーザーにもspace-vimの恩恵を提供するため、Unix向けinstall.shに相当する機能をWindows環境で実現する。PowerShellを活用することで、Windows特有の操作（シンボリックリンク作成、ファイルダウンロード等）を適切に処理し、ユーザーが簡単にspace-vim環境を構築できるようにする。

**バッチの実行タイミング**：初回インストール時に手動実行。更新時はリポジトリが既に存在する場合、git pullによる更新を行う。

**主要な処理内容**：
1. git.exeとvim.exeの存在確認
2. space-vimリポジトリのクローンまたは更新
3. vim-plugプラグインマネージャーのダウンロード
4. .vimrcへのシンボリックリンク作成
5. .spacevimユーザー設定ファイルの生成

**前後の処理との関連**：このスクリプトは単独で実行される初期セットアップ処理であり、前提バッチはない。後続処理として、ユーザーがGVimを起動すると自動的にプラグインがインストールされる。

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

## バッチ種別

インストール処理 / 環境構築

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（初回インストール時または更新時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| git.exe | システムのPATHにgitがインストールされていること |
| vim.exe | システムのPATHにvimがインストールされていること |
| PowerShell | PowerShellが利用可能であること |
| インターネット接続 | GitHubへのアクセスが必要 |

### 実行可否判定

スクリプト開始時にgit.exeとvim.exeの存在を確認し、どちらか一方でも存在しない場合はエラーメッセージを表示して終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本スクリプトはコマンドライン引数を受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| GitHub リポジトリ | Git | https://github.com/liuchengxu/space-vim.git |
| vim-plug | Vim script | https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| $HOME\.space-vim\ | ディレクトリ | space-vimリポジトリのクローン |
| $HOME\.vimrc | シンボリックリンク | Vim用設定ファイル |
| $HOME\.spacevim | ファイル | ユーザー設定ファイル（init.spacevimのコピー） |
| $HOME\.vim\autoload\plug.vim | ファイル | vim-plug |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. PowerShellでスクリプトを実行開始
   └─ バナー表示
2. ホームディレクトリに移動（Push-Location ~）
3. git.exeの存在確認
   └─ 存在しない場合はエラーメッセージを表示して終了
4. vim.exeの存在確認
   └─ 存在しない場合はエラーメッセージを表示して終了
5. リポジトリの同期
   └─ ~/.space-vim が存在しない場合: git clone
   └─ 存在する場合: git pull origin master
6. vim-plugのダウンロード
   └─ ~/.vim/autoload/plug.vim が存在しない場合: ダウンロード
   └─ 存在する場合: スキップ
7. .vimrcの作成
   └─ 存在しない場合: シンボリックリンク作成（mklink）
   └─ 存在する場合: スキップ
8. .spacevimの作成
   └─ 存在しない場合: init.spacevimをコピー
   └─ 存在する場合: スキップ
9. 完了メッセージの表示
   └─ GVimを開くとプラグインが自動インストールされる旨を案内
10. pause で一時停止
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[バナー表示]
    B --> C{git.exeが存在するか}
    C -->|No| D[エラー終了]
    C -->|Yes| E{vim.exeが存在するか}
    E -->|No| D
    E -->|Yes| F{~/.space-vimが存在するか}
    F -->|No| G[git clone実行]
    F -->|Yes| H[git pull実行]
    G --> I{plug.vimが存在するか}
    H --> I
    I -->|No| J[vim-plugダウンロード]
    I -->|Yes| K[スキップ]
    J --> L{.vimrcが存在するか}
    K --> L
    L -->|No| M[シンボリックリンク作成]
    L -->|Yes| N[スキップ]
    M --> O{.spacevimが存在するか}
    N --> O
    O -->|No| P[init.spacevimをコピー]
    O -->|Yes| Q[スキップ]
    P --> R[完了メッセージ表示]
    Q --> R
    R --> S[pause]
    S --> T[バッチ終了]
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 依存関係エラー | git.exeがPATHに存在しない | gitをインストールしPATHに追加する |
| - | 依存関係エラー | vim.exeがPATHに存在しない | vimをインストールしPATHに追加する |
| - | ネットワークエラー | GitHubへの接続失敗 | ネットワーク接続を確認する |

### リトライ仕様

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

### 障害時対応

- git clone/pull 失敗時: ネットワーク接続を確認し、再実行する
- vim-plugダウンロード失敗時: URLが変更されていないか確認する
- シンボリックリンク作成失敗時: 管理者権限で実行する

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（バッチファイルのためトランザクション管理なし） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回/インストール |
| 目標処理時間 | ネットワーク速度依存（通常1-5分） |
| メモリ使用量上限 | 最小限（バッチファイルのため） |

## 排他制御

同時実行の想定なし。同一ユーザーが複数回同時実行した場合、git操作での競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | リポジトリ同期開始時 | "==> Trying to clone/update space-vim" |
| 進捗ログ | vim-plugダウンロード時 | "==> Trying to download vim-plug" |
| 状態ログ | 既存ファイル検出時 | "[OK] plug.vim/vimrc/.spacevim is ready/already exists" |
| 完了ログ | 処理完了時 | "Thanks for installing space-vim. Enjoy!" |

## 監視・アラート

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

## 備考

- PowerShellの実行ポリシーをBypassモードで実行（`-ExecutionPolicy Bypass`）
- プラグインのインストールはGVimを開いた時に自動実行される（スクリプト内では実行しない）
- シンボリックリンク作成には管理者権限が必要な場合がある
- Net.WebClientを使用してvim-plugをダウンロードする
- Unix版と異なり、既存設定ファイルの自動バックアップ機能はない
