Merge pull request #102 from objectstack-ai/copilot/configure-pnpm-merge-driver

Author: huangyiirene

.gitattributes

@@ -0,0 +1,4 @@
+# pnpm-lock.yaml merge driver
+# This custom merge driver automatically resolves conflicts in pnpm-lock.yaml
+# by regenerating the lock file using 'pnpm install'
+pnpm-lock.yaml merge=pnpm-merge

docs/guide/ide-setup.md

@@ -15,6 +15,32 @@ Essential for editing `*.object.yml` files. It provides syntax highlighting and
 **2. JSON (Official)**  
 For editing configuration files.
 
+## Git Configuration
+
+### PNPM Lock File Merge Driver
+
+To avoid manual merge conflicts in `pnpm-lock.yaml`, run the setup script after cloning the repository:
+
+```bash
+bash scripts/setup-merge-driver.sh
+```
+
+This configures Git to automatically regenerate the lock file when conflicts occur by running `pnpm install`.
+
+**What it does:**
+- Configures a custom merge driver named "pnpm-merge"
+- When `pnpm-lock.yaml` has merge conflicts, Git will automatically run `pnpm install` to regenerate it
+- This eliminates the need to manually resolve lock file conflicts
+
+**Manual Configuration:**
+
+If you prefer to configure manually, run:
+
+```bash
+git config merge.pnpm-merge.name "pnpm-lock.yaml merge driver"
+git config merge.pnpm-merge.driver "pnpm install"
+```
+
 ## AI Assistant Configuration
 
 ObjectQL is designed to be "AI-Native". The most efficient way to write schema and hooks is by pairing with an LLM.

scripts/setup-merge-driver.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Setup script for configuring the pnpm-lock.yaml merge driver
+# This script configures Git to automatically resolve conflicts in pnpm-lock.yaml
+# by regenerating the lock file using 'pnpm install'
+
+echo "Configuring pnpm-lock.yaml merge driver..."
+
+# Configure the merge driver
+git config merge.pnpm-merge.name "pnpm-lock.yaml merge driver"
+git config merge.pnpm-merge.driver "pnpm install"
+
+if [ $? -eq 0 ]; then
+  echo "✓ pnpm-lock.yaml merge driver configured successfully"
+  echo ""
+  echo "The merge driver will automatically regenerate pnpm-lock.yaml when conflicts occur."
+  echo "You can verify the configuration with: git config --get merge.pnpm-merge.driver"
+else
+  echo "✗ Failed to configure merge driver"
+  exit 1
+fi