@aku11i/phantom 0.4.0 → 0.6.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) • [ドキュメント](#-ドキュメント)
 
@@ -24,6 +25,7 @@ Phantomは、Git worktreeの管理を劇的にシンプルにするCLIツール
 - 🎯 **ブランチとWorktreeの同期** - 各worktreeに対応するブランチを自動作成
 - 🐚 **インタラクティブシェル** - SSH風のworktreeナビゲーション体験
 - ⚡ **ゼロ設定** - 賢明なデフォルト設定ですぐに使用可能
+- 📦 **ゼロ依存** - 外部依存関係がなく軽量で高速
 
 ## 🤔 なぜPhantom？
 
@@ -55,6 +57,9 @@ npm install -g @aku11i/phantom
 # 新しいworktreeを作成
 phantom create feature-awesome
 
+# 既存のブランチにアタッチ
+phantom attach existing-branch
+
 # worktreeにジャンプ
 phantom shell feature-awesome
 
@@ -104,6 +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
@@ -149,7 +169,7 @@ tmuxとPhantomを組み合わせることで、驚くほど効率的なワーク
 
 ```bash
 # 新しいtmuxウィンドウを開いて、同時にworktreeを作成
-tmux new-window 'phantom create new-feature --shell'
+tmux new-window 'phantom create --shell new-feature'
 ```
 
 このたった1行のコマンドで：
@@ -163,8 +183,11 @@ tmux new-window 'phantom create new-feature --shell'
 
 ```bash
 # worktreeを作成してすぐにVS Codeで開く
-phantom create feature-auth
-phantom exec feature-auth code .
+phantom create --exec "code ." new-feature
+phantom create --exec "cursor ." new-feature # Cursorでも動作します！
+
+# 既存のブランチにアタッチしてVS Codeで開く
+phantom attach --exec "code ." feature/existing-branch
 ```
 
 ### 並行開発ワークフロー
@@ -184,11 +207,55 @@ phantom shell feature-awesome  # 機能開発を続行
 | 機能 | Git Worktree | Phantom |
 |---------|--------------|---------|
 | worktree + ブランチの作成 | `git worktree add -b feature ../project-feature` | `phantom create feature` |
+| 既存のブランチにアタッチ | `git worktree add ../project-feature feature` | `phantom attach feature` |
 | worktreeのリスト表示 | `git worktree list` | `phantom list` |
 | worktreeへの移動 | `cd ../project-feature` | `phantom shell feature` |
 | 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"
+    ]
+  }
+}
+```
+
+### ファイルコピー機能
+
+新しい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パターンはサポートされていません。ファイルはリポジトリルートからの相対パスで正確に指定する必要があります。
+
 ## 🛠️ 開発
 
 ```bash
@@ -200,8 +267,11 @@ pnpm install
 # テストの実行
 pnpm test
 
+# 特定のテストファイルを実行
+pnpm test:file src/core/worktree/create.test.js
+
 # 型チェック
-pnpm type-check
+pnpm typecheck
 
 # リンティング
 pnpm lint
@@ -262,6 +332,33 @@ Phantomの新しいバージョンをリリースするには：
      --target main
    ```
 
+7. **リリースノートを分かりやすく更新**
+   - 自動生成されたリリースノートをレビュー
+   - 重要な詳細についてはPRの説明を確認
+   - リリースノートをよりユーザーフレンドリーに更新：
+     - 変更をカテゴリー別にグループ化（機能、バグ修正、改善）
+     - 新機能には使用例を追加
+     - 変更の影響を平易な言葉で説明
+     - セキュリティ修正と破壊的変更を強調
+   
+   ```bash
+   # リリースノートを編集
+   gh release edit v<version> --notes "$(cat <<'EOF'
+   ## 🚀 v<version> の新機能
+   
+   ### ✨ 新機能
+   - 使用例付きの機能説明
+   
+   ### 🐛 バグ修正
+   - 修正内容の明確な説明
+   
+   ### 🛠️ 改善
+   - パフォーマンス、セキュリティ、その他の改善
+   
+   EOF
+   )"
+   ```
+
 ビルドプロセスは`prepublishOnly`スクリプトによって自動的に処理され、以下を行います：
 - すべてのテストとチェックを実行
 - esbuildを使用してTypeScriptソースをJavaScriptにビルド

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)
 
@@ -24,6 +25,7 @@ Phantom is a CLI tool that dramatically simplifies Git worktree management. It's
 - 🎯 **Branch-Worktree Sync** - Automatically creates matching branches for each worktree
 - 🐚 **Interactive Shell** - SSH-like experience for worktree navigation
 - ⚡ **Zero Configuration** - Works out of the box with sensible defaults
+- 📦 **Zero Dependencies** - Lightweight and fast with no external dependencies
 
 ## 🤔 Why Phantom?
 
@@ -55,6 +57,9 @@ npm install -g @aku11i/phantom
 # Create a new worktree
 phantom create feature-awesome
 
+# Attach to an existing branch
+phantom attach existing-branch
+
 # Jump into the worktree
 phantom shell feature-awesome
 
@@ -104,6 +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
@@ -114,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
@@ -149,7 +171,7 @@ Combine tmux with Phantom for an incredibly efficient workflow:
 
 ```bash
 # Open a new tmux window and create a worktree in one command
-tmux new-window 'phantom create new-feature --shell'
+tmux new-window 'phantom create --shell new-feature'
 ```
 
 This single line:
@@ -163,8 +185,11 @@ When developing multiple features in parallel, you can manage each feature in it
 
 ```bash
 # Create a worktree and immediately open it in VS Code
-phantom create feature-auth
-phantom exec feature-auth code .
+phantom create --exec "code ." new-feature
+phantom create --exec "cursor ." new-feature # also works with cursor!!
+
+# Attach to existing branch and open in VS Code
+phantom attach --exec "code ." feature/existing-branch
 ```
 
 ### Parallel Development Workflow
@@ -184,10 +209,55 @@ phantom shell feature-awesome  # Continue feature development
 | Feature | Git Worktree | Phantom |
 |---------|--------------|---------|
 | Create worktree + branch | `git worktree add -b feature ../project-feature` | `phantom create feature` |
+| Attach to existing branch | `git worktree add ../project-feature feature` | `phantom attach feature` |
 | List worktrees | `git worktree list` | `phantom list` |
 | 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 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"
+    ]
+  }
+}
+```
+
+### 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.
 
 ## 🛠️ Development
 
@@ -200,8 +270,11 @@ pnpm install
 # Run tests
 pnpm test
 
+# Run a specific test file
+pnpm test:file src/core/worktree/create.test.js
+
 # Type checking
-pnpm type-check
+pnpm typecheck
 
 # Linting
 pnpm lint
@@ -262,6 +335,33 @@ To release a new version of Phantom:
      --target main
    ```
 
+7. **Update release notes for clarity**
+   - Review the auto-generated release notes
+   - Check PR descriptions for important details
+   - Update the release notes to be more user-friendly:
+     - Group changes by category (Features, Bug Fixes, Improvements)
+     - Add usage examples for new features
+     - Explain the impact of changes in plain language
+     - Highlight security fixes and breaking changes
+   
+   ```bash
+   # Edit the release notes
+   gh release edit v<version> --notes "$(cat <<'EOF'
+   ## 🚀 What's New in v<version>
+   
+   ### ✨ New Features
+   - Feature description with usage example
+   
+   ### 🐛 Bug Fixes
+   - Clear description of what was fixed
+   
+   ### 🛠️ Improvements
+   - Performance, security, or other improvements
+   
+   EOF
+   )"
+   ```
+
 The build process is automatically handled by the `prepublishOnly` script, which:
 - Runs all tests and checks
 - Builds the TypeScript source to JavaScript using esbuild