build(examples): Add pre-commit lockfile copy script

Author: bgins

.pre-commit-config.yaml

@@ -28,3 +28,12 @@ repos:
       - id: check-executables-have-shebangs
       - id: check-toml
         exclude: ^(rust|rust+wasm)
+
+  - repo: local
+    hooks:
+      - id: copy-example-lockfiles
+        name: copy example cargo lockfiles
+        entry: scripts/copy-example-lockfiles.sh
+        language: script
+        files: ^examples/(Cargo\.(toml|lock)|.*/Cargo\.toml)$
+        pass_filenames: false

examples/README.md

@@ -2,6 +2,21 @@ This workspace contains numerous examples demonstrating template-generated
 code and combinations. Each example is setup as its own crate, with its own
 dependencies.
 
+## Cargo.lock Synchronization
+
+The workspace automatically maintains synchronized `Cargo.lock` files for all
+example templates. When dependencies are updated at the workspace level, a
+pre-commit hook automatically copies the workspace `Cargo.lock` to each example
+directory that contains a `Cargo.toml` file. This ensures all templates have
+up-to-date dependency resolution for use with `cargo generate`.
+
+This synchronization happens automatically during commits when `Cargo.toml` or
+`Cargo.lock` files are modified. You can also run it manually:
+
+```console
+./scripts/copy-example-lockfiles.sh
+```
+
 ## Running Examples
 
 To run any example from this top-level:

scripts/copy-example-lockfiles.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# Script to copy workspace Cargo.lock to all example template directories
+# This ensures templates have up-to-date lock files for cargo generate
+
+set -e
+
+# Define paths
+WORKSPACE_LOCK="examples/Cargo.lock"
+EXAMPLES_DIR="examples"
+
+# Check if workspace lock file exists
+if [[ ! -f "$WORKSPACE_LOCK" ]]; then
+    echo "Error: Workspace Cargo.lock not found at $WORKSPACE_LOCK"
+    exit 1
+fi
+
+# Check if examples directory exists
+if [[ ! -d "$EXAMPLES_DIR" ]]; then
+    echo "Error: Examples directory not found at $EXAMPLES_DIR"
+    exit 1
+fi
+
+# Find all subdirectories in examples/ that contain a Cargo.toml (excluding target)
+example_dirs=()
+while IFS= read -r -d '' dir; do
+    # Skip the target directory
+    if [[ "$(basename "$dir")" == "target" ]]; then
+        continue
+    fi
+
+    # Check if the directory contains a Cargo.toml file
+    if [[ -f "$dir/Cargo.toml" ]]; then
+        example_dirs+=("$dir")
+    fi
+done < <(find "$EXAMPLES_DIR" -mindepth 1 -maxdepth 1 -type d -print0)
+
+# Check if we found any example directories
+if [[ ${#example_dirs[@]} -eq 0 ]]; then
+    echo "No example directories with Cargo.toml found in $EXAMPLES_DIR"
+    exit 0
+fi
+
+# Copy workspace lock to each example directory
+copied_count=0
+for example_dir in "${example_dirs[@]}"; do
+    target_lock="$example_dir/Cargo.lock"
+    cp "$WORKSPACE_LOCK" "$target_lock"
+    echo "Copied $WORKSPACE_LOCK to $target_lock"
+    ((copied_count++))
+done
+
+echo "Successfully copied Cargo.lock to $copied_count example template(s)"