@aku11i/phantom 0.5.0 → 0.7.0

package/README.ja.md

@@ -7,6 +7,7 @@
 [![npm version](https://img.shields.io/npm/v/@aku11i/phantom.svg)](https://www.npmjs.com/package/@aku11i/phantom)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node.js Version](https://img.shields.io/node/v/@aku11i/phantom.svg)](https://nodejs.org)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/aku11i/phantom)
 
 [インストール](#-インストール) • [基本的な使い方](#-基本的な使い方) • [なぜPhantom？](#-なぜphantom) • [ドキュメント](#-ドキュメント)
 
@@ -108,9 +109,21 @@ npm link
 ```bash
 # 対応するブランチを持つ新しいworktreeを作成
 phantom create <name>
+phantom create <name> --shell  # 作成してインタラクティブシェルに入る
+phantom create <name> --exec <command>  # 作成してコマンドを実行
+phantom create <name> --tmux  # 作成して新しいtmuxウィンドウで開く
+phantom create <name> --tmux-vertical  # 作成してtmuxペインを縦に分割
+phantom create <name> --tmux-v  # --tmux-verticalの短縮形
+phantom create <name> --tmux-horizontal  # 作成してtmuxペインを横に分割
+phantom create <name> --tmux-h  # --tmux-horizontalの短縮形
+
+# worktreeを作成し、特定のファイルをコピー
+phantom create <name> --copy-file ".env" --copy-file ".env.local"
 
 # 既存のブランチにworktreeとしてアタッチ
 phantom attach <branch-name>
+phantom attach <branch-name> --shell  # アタッチしてインタラクティブシェルに入る
+phantom attach <branch-name> --exec <command>  # アタッチしてコマンドを実行
 
 # すべてのworktreeとその現在のステータスをリスト表示
 phantom list
@@ -200,6 +213,79 @@ phantom shell feature-awesome  # 機能開発を続行
 | worktreeでコマンド実行 | `cd ../project-feature && npm test` | `phantom exec feature npm test` |
 | worktreeの削除 | `git worktree remove ../project-feature` | `phantom delete feature` |
 
+## ⚙️ 設定
+
+Phantomはリポジトリルートの`phantom.config.json`ファイルによる設定をサポートします。これにより、新しいworktreeを作成する際に自動的にコピーされるファイルの定義や、実行されるコマンドを設定できます。
+
+### 設定ファイル
+
+リポジトリルートに`phantom.config.json`ファイルを作成します：
+
+```json
+{
+  "postCreate": {
+    "copyFiles": [
+      ".env",
+      ".env.local",
+      "config/local.json"
+    ],
+    "commands": [
+      "pnpm install",
+      "pnpm build"
+    ]
+  }
+}
+```
+
+### ファイルコピー機能
+
+新しいworktreeを作成する際、Phantomは現在のworktreeから新しいworktreeへ指定されたファイルを自動的にコピーできます。これは以下のような場合に特に便利です：
+
+- 環境設定ファイル（`.env`、`.env.local`）
+- ローカル開発設定
+- gitignoreされているシークレットファイル
+
+ファイルのコピーは2つの方法で指定できます：
+
+1. **コマンドラインオプションを使用：**
+   ```bash
+   phantom create feature --copy-file ".env" --copy-file ".env.local" --copy-file "config/local.json"
+   ```
+
+2. **設定ファイルを使用：**
+   `phantom.config.json`で一度設定すれば、すべての新しいworktreeに適用されます。
+
+3. **両方を使用：**
+   設定ファイルとコマンドラインオプションの両方で指定されたファイルはマージされます（重複は削除されます）。
+
+> **注意：** 現在、globパターンはサポートされていません。ファイルはリポジトリルートからの相対パスで正確に指定する必要があります。
+
+### 作成後コマンド
+
+Phantomは新しいworktreeを作成した後に自動的にコマンドを実行できます。これは以下のような場合に便利です：
+
+- 依存関係のインストール（`pnpm install`、`npm install`、`yarn install`）
+- プロジェクトのビルド
+- 開発環境のセットアップ
+- データベースマイグレーションの実行
+- プロジェクト固有のその他のセットアップタスク
+
+コマンドは設定ファイルで指定された順序で実行されます。コマンドが失敗した場合、作成プロセスは停止し、エラーが報告されます。
+
+使用例：
+```json
+{
+  "postCreate": {
+    "commands": [
+      "pnpm install",           // 依存関係をインストール
+      "pnpm db:migrate",        // データベースマイグレーションを実行
+      "cp .env.example .env",   // テンプレートから環境ファイルを作成
+      "pnpm build"              // プロジェクトをビルド
+    ]
+  }
+}
+```
+
 ## 🛠️ 開発
 
 ```bash
@@ -211,6 +297,9 @@ pnpm install
 # テストの実行
 pnpm test
 
+# 特定のテストファイルを実行
+pnpm test:file src/core/worktree/create.test.js
+
 # 型チェック
 pnpm typecheck
 
@@ -274,8 +363,8 @@ Phantomの新しいバージョンをリリースするには：
    ```
 
 7. **リリースノートを分かりやすく更新**
-   - 自動生成されたリリースノートをレビュー
-   - 重要な詳細についてはPRの説明を確認
+   - 自動生成されたリリースノートを`gh release view v<version>`でレビュー
+   - 重要な詳細についてはPRの説明を`gh pr view <number>`で確認
    - リリースノートをよりユーザーフレンドリーに更新：
      - 変更をカテゴリー別にグループ化（機能、バグ修正、改善）
      - 新機能には使用例を追加

package/README.md

@@ -7,6 +7,7 @@
 [![npm version](https://img.shields.io/npm/v/@aku11i/phantom.svg)](https://www.npmjs.com/package/@aku11i/phantom)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node.js Version](https://img.shields.io/node/v/@aku11i/phantom.svg)](https://nodejs.org)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/aku11i/phantom)
 
 [Installation](#-installation) • [Basic Usage](#-basic-usage) • [Why Phantom?](#-why-phantom) • [Documentation](#-documentation) • [日本語](./README.ja.md)
 
@@ -108,9 +109,21 @@ npm link
 ```bash
 # Create a new worktree with a matching branch
 phantom create <name>
+phantom create <name> --shell  # Create and enter interactive shell
+phantom create <name> --exec <command>  # Create and execute command
+phantom create <name> --tmux  # Create and open in new tmux window
+phantom create <name> --tmux-vertical  # Create and split tmux pane vertically
+phantom create <name> --tmux-v  # Shorthand for --tmux-vertical
+phantom create <name> --tmux-horizontal  # Create and split tmux pane horizontally
+phantom create <name> --tmux-h  # Shorthand for --tmux-horizontal
+
+# Create a worktree and copy specific files
+phantom create <name> --copy-file ".env" --copy-file ".env.local"
 
 # Attach to an existing branch as a worktree
 phantom attach <branch-name>
+phantom attach <branch-name> --shell  # Attach and enter interactive shell
+phantom attach <branch-name> --exec <command>  # Attach and execute command
 
 # List all worktrees with their current status
 phantom list
@@ -121,6 +134,8 @@ phantom where <name>
 # Delete a worktree and its branch
 phantom delete <name>
 phantom delete <name> --force  # Force delete with uncommitted changes
+phantom delete --current        # Delete the current worktree (when inside one)
+phantom delete --current --force # Force delete current worktree
 ```
 
 #### Working with Worktrees
@@ -199,6 +214,80 @@ phantom shell feature-awesome  # Continue feature development
 | Navigate to worktree | `cd ../project-feature` | `phantom shell feature` |
 | Run command in worktree | `cd ../project-feature && npm test` | `phantom exec feature npm test` |
 | Remove worktree | `git worktree remove ../project-feature` | `phantom delete feature` |
+| Remove current worktree | `cd .. && git worktree remove project-feature` | `phantom delete --current` |
+
+## ⚙️ Configuration
+
+Phantom supports configuration through a `phantom.config.json` file in your repository root. This allows you to define files to be automatically copied and commands to be executed when creating new worktrees.
+
+### Configuration File
+
+Create a `phantom.config.json` file in your repository root:
+
+```json
+{
+  "postCreate": {
+    "copyFiles": [
+      ".env",
+      ".env.local",
+      "config/local.json"
+    ],
+    "commands": [
+      "pnpm install",
+      "pnpm build"
+    ]
+  }
+}
+```
+
+### Copy Files Feature
+
+When creating a new worktree, Phantom can automatically copy specified files from your current worktree to the new one. This is particularly useful for:
+
+- Environment configuration files (`.env`, `.env.local`)
+- Local development settings
+- Secret files that are gitignored
+
+You can specify files to copy in two ways:
+
+1. **Using the command line option:**
+   ```bash
+   phantom create feature --copy-file ".env" --copy-file ".env.local" --copy-file "config/local.json"
+   ```
+
+2. **Using the configuration file:**
+   Configure once in `phantom.config.json` and it will apply to all new worktrees.
+
+3. **Using both:**
+   Files specified in both the configuration file and command line options are merged together (duplicates are removed).
+
+> **Note:** Currently, glob patterns are not supported. Files must be specified with their exact paths relative to the repository root.
+
+### Post-Create Commands
+
+Phantom can automatically execute commands after creating a new worktree. This is useful for:
+
+- Installing dependencies (`pnpm install`, `npm install`, `yarn install`)
+- Building the project
+- Setting up the development environment
+- Running database migrations
+- Any other setup tasks specific to your project
+
+Commands are executed in the order they are specified in the configuration file. If a command fails, the creation process will stop and report the error.
+
+Example use cases:
+```json
+{
+  "postCreate": {
+    "commands": [
+      "pnpm install",           // Install dependencies
+      "pnpm db:migrate",        // Run database migrations
+      "cp .env.example .env",   // Create environment file from template
+      "pnpm build"              // Build the project
+    ]
+  }
+}
+```
 
 ## 🛠️ Development
 
@@ -211,6 +300,9 @@ pnpm install
 # Run tests
 pnpm test
 
+# Run a specific test file
+pnpm test:file src/core/worktree/create.test.js
+
 # Type checking
 pnpm typecheck
 
@@ -274,8 +366,8 @@ To release a new version of Phantom:
    ```
 
 7. **Update release notes for clarity**
-   - Review the auto-generated release notes
-   - Check PR descriptions for important details
+   - Review the auto-generated release notes using `gh release view v<version>`
+   - Check PR descriptions for important details using `gh pr view <number>`
    - Update the release notes to be more user-friendly:
      - Group changes by category (Features, Bug Fixes, Improvements)
      - Add usage examples for new features