Stacked PR Sync

A simple tool to sync stacked pull requests with smart conflict detection.

🚀 Quick Start

# Use directly (no installation needed)
npx stacked-pr-sync master feature1 feature2 feature3

That's it! 🎉

📦 Installation Options

Option 1: Use with npx (Recommended)

# No installation needed - works from anywhere
npx stacked-pr-sync master feature1 feature2 feature3

Option 2: Install as Dev Dependency

# Install in your project
npm install --save-dev stacked-pr-sync

# Use with npx (automatically uses local version)
npx stacked-pr-sync master feature1 feature2 feature3

# Or add to package.json scripts
{
  "scripts": {
    "sync": "stacked-pr-sync",
    "sync:feature": "stacked-pr-sync master feature1 feature2 feature3"
  }
}

# Then run
npm run sync master feature1 feature2 feature3
# OR
npm run sync:feature

Option 3: Global Install

# Install globally
npm install -g stacked-pr-sync

# Use directly
stacked-pr-sync master feature1 feature2 feature3

📋 How It Works

Syncs branches in sequence: master → feature1 → feature2 → feature3

1. Checks branch status and shows what needs syncing
2. Syncs with origin (if you want)
3. Merges branches locally in order
4. Stops on conflicts - you resolve them manually
5. Offers to push changes when done

🎯 Example

# You have changes in feature3, want to sync up to master
npx stacked-pr-sync master feature1 feature2 feature3

# Tool shows:
📋 Branch Status Report:
✅ master: In sync with origin
❌ feature1: Out of sync (local ahead by 2 commits)
🏠 feature2: No remote branch found

# You choose to sync with origin
# Tool merges: master → feature1 → feature2 → feature3
# If conflicts occur, tool stops and you resolve them
# After resolving, run the same command again

🔧 Options

# Show help
npx stacked-pr-sync --help

🛡️ Safety Features

• Smart detection: Shows exactly what each branch needs
• Auto-stash: Safely handles uncommitted changes
• Conflict safety: Stops immediately on conflicts
• User control: You choose what to sync and push

🚨 When Conflicts Occur

❌ Merge conflicts detected in feature2
🛑 Sync aborted due to conflicts.

# You resolve conflicts manually:
git add .
git commit

# Then restart:
npx stacked-pr-sync master feature1 feature2 feature3

📁 Configuration (Optional)

Create stacked-pr-config.json for reusable branch stacks:

{
  "stacks": {
    "my-feature": {
      "branches": ["master", "feature1", "feature2", "feature3"]
    }
  },
  "defaultStack": "my-feature"
}

Then use:

npx stacked-pr-sync my-feature

💡 Pro Tips

• Start with base branch: List branches in dependency order
• Resolve conflicts: Tool stops, you resolve, then restart
• Push when ready: Choose what to push after successful sync

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Submit a pull request

📄 License

MIT License

Simple, safe, and effective stacked PR syncing 🚀