# バッチ設計書 4-doomscript

## 概要

本ドキュメントは、Doom CLIフレームワークを事前読み込みしたEmacs Lispスクリプト用のshebangインタプリタである`doomscript`の設計仕様を定義するものである。

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

`doomscript`は、Doom Emacsのコマンドラインフレームワークを活用したカスタムElispスクリプトを実行するためのshebangインタプリタである。ユーザーは自作のスクリプトファイルの先頭に`#!/usr/bin/env doomscript`と記述することで、Doom CLIの機能（print!マクロ等）を利用したスクリプトを実行できる。

**業務上の目的・背景**：Doom Emacsには強力なCLIフレームワークが存在し、高度なロギング、カラー出力、プロセス管理などの機能を提供している。`doomscript`を使用することで、ユーザーはこれらの機能を自作スクリプトでも活用でき、シェルスクリプトやPythonスクリプトを書くことなく、Emacs Lispで統一された自動化タスクを実現できる。

**バッチの実行タイミング**：ユーザーが作成したdoomscriptを実行する際に随時呼び出される。

**主要な処理内容**：
1. スクリプトファイルの存在確認と引数の検証
2. Emacs実行可能ファイルの検索と確認
3. EMACSDIRの設定と早期初期化ファイルの確認
4. ターミナル環境情報の設定（サイズ、パイプ状態等）
5. Emacsをバッチモードで起動し、early-init.elとユーザースクリプトを読み込み
6. 終了コード254の場合、生成された終了スクリプトを実行

**前後の処理との関連**：Doom Emacsのearly-init.elをブートストラップとして使用し、CLIフレームワークの全機能を利用可能にする。

**影響範囲**：実行するスクリプトに依存する。Doom設定やパッケージに影響を与える可能性がある。

## バッチ種別

shebangインタプリタ / スクリプトランナー

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | ユーザー任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動（ユーザースクリプト実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Emacs インストール | Emacs が $PATH に存在し実行可能であること |
| Doom Emacs インストール | $EMACSDIR に early-init.el が存在すること |
| doomscript が PATH に存在 | shebang から呼び出せるよう PATH に追加されていること |
| 引数としてスクリプトファイル | 実行するスクリプトファイルのパスが指定されていること |

### 実行可否判定

1. 引数が1つ以上指定されていること（スクリプトファイルパス）
2. `$EMACS`または`emacs`コマンドが実行可能であること
3. `$EMACSDIR/early-init.el`が存在すること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $1 (script) | ファイルパス | Yes | なし | 実行するElispスクリプトのパス |
| $2... | 任意 | No | なし | スクリプトに渡す追加の引数 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| スクリプトファイル | Emacs Lisp | 実行するElispスクリプト |
| $EMACSDIR/early-init.el | Emacs Lisp | Doom Emacs ブートストラップ |
| 環境変数 $EMACS | パス/コマンド | Emacs実行ファイル |
| 環境変数 $EMACSDIR | パス | Doom Emacsインストールディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | スクリプトの出力結果 |
| 標準エラー出力 | テキスト | エラーメッセージ |
| $TMPDIR/doom.*.sh | シェルスクリプト | 終了スクリプト（終了コード254の場合） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | doom.${__DOOMPID}.${__DOOMSTEP}.sh |
| 出力先 | $TMPDIR |
| 文字コード | UTF-8 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. 引数の検証
   └─ 引数が0の場合、エラーで終了

2. Emacs実行可能ファイルの確認
   └─ $EMACS の確認（ansi-term/vterm内では emacs にフォールバック）
   └─ type コマンドで実行可能性を確認

3. Emacsコマンドの構築
   └─ $EMACS -q --no-site-file --batch

4. EMACSDIRの設定
   └─ $BASH_SOURCE からディレクトリを特定
   └─ early-init.el の存在確認

5. ターミナル環境変数の設定
   └─ __DOOMSH, __DOOMPID, __DOOMSTEP, __DOOMGEOM, __DOOMPIPE

6. スクリプトの実行
   └─ early-init.el の読み込み
   └─ ユーザースクリプトの読み込みと実行

7. 終了スクリプト処理（終了コード254の場合）
   └─ sh "${TMPDIR}/doom.*.sh" の実行
```

### フローチャート

```mermaid
flowchart TD
    A[doomscript 開始] --> B{引数確認}
    B -->|なし| C[エラー: ファイル引数必要]
    B -->|あり| D{Emacs存在確認}
    D -->|なし| E[エラー: Emacs未発見]
    D -->|あり| F{early-init.el確認}
    F -->|なし| G[エラー: Doom未発見]
    F -->|あり| H[環境変数設定]
    H --> I[Emacsバッチモード起動]
    I --> J[early-init.el読み込み]
    J --> K[ユーザースクリプト実行]
    K --> L{終了コード確認}
    L -->|254| M[終了スクリプト実行]
    L -->|その他| N[終了]
    M --> N
```

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

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

本スクリプト自体はデータベースを使用しない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

データベース操作は行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 引数エラー | スクリプトファイル引数がない | スクリプトパスを指定 |
| 1 | Emacs未発見 | Emacsが見つからない | Emacsをインストールしてパスを通す |
| 1 | Doom未発見 | early-init.elが見つからない | $EMACSDIRを正しく設定 |
| 254 | 継続実行 | 終了スクリプト実行要求 | 自動処理される |
| その他 | スクリプト由来 | 実行スクリプトからのエラー | スクリプト内容を確認 |

### リトライ仕様

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

### 障害時対応

1. `$EMACSDIR`環境変数が正しく設定されているか確認
2. `$EMACS`環境変数でEmacsパスを明示的に指定
3. doomscriptが`$PATH`に含まれているか確認

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回/実行 |
| 目標処理時間 | スクリプト内容に依存 |
| メモリ使用量上限 | Emacsプロセス標準使用量 |

## 排他制御

実行するスクリプトの内容に依存する。doomscript自体に排他制御はない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | エラー発生時 | エラーメッセージ（標準エラー出力） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | 実行スクリプトの監視に従う |

## 備考

- shebang使用例: `#!/usr/bin/env doomscript`
- スクリプト内で`print!`マクロなどのDoom CLI機能を使用可能
- `-Q`ではなく`-q --no-site-file`を使用（site-lispディレクトリを保持するため）
- `bin/doom`で使用されない理由: PATHまたは絶対パスの要件がより柔軟性を制限するため
- POSIX互換性を重視しつつも、`$BASH_SOURCE`を使用してディレクトリを特定
- `/tmp`がnoexecでマウントされている場合でも動作（shにスクリプトを渡す）
