Prisma Schema Sync

Prisma Schema Sync - Hook for Claude - Claude Pro Directory

Hook Content

The main content for this hook.

post-tool-use.json

json

{
  "hookConfig": {
    "hooks": {
      "postToolUse": {
        "script": "./.claude/hooks/prisma-schema-sync.sh",
        "matchers": [
          "write",
          "edit"
        ]
      }
    }
  },
  "scriptContent": "#!/bin/bash\n\n# Read the tool input from stdin\nINPUT=$(cat)\nTOOL_NAME=$(echo \"$INPUT\" | jq -r '.tool_name')\nFILE_PATH=$(echo \"$INPUT\" | jq -r '.tool_input.file_path // .tool_input.path // \"\"')\n\nif [ -z \"$FILE_PATH\" ]; then\n  exit 0\nfi\n\n# Check if this is a Prisma schema file\nif [[ \"$FILE_PATH\" == *schema.prisma ]]; then\n    echo \"🔄 Prisma Schema Sync - Processing schema changes...\"\n    echo \"📄 Schema file: $FILE_PATH\"\n    \n    # Check if Prisma is available\n    if ! command -v npx >/dev/null 2>&1; then\n        echo \"⚠️ npx not found. Please install Node.js and npm\"\n        exit 1\n    fi\n    \n    # Step 1: Validate schema\n    echo \"🔍 Validating Prisma schema...\"\n    if npx prisma validate; then\n        echo \"✅ Schema validation passed\"\n    else\n        echo \"❌ Schema validation failed - Please fix errors before proceeding\"\n        exit 1\n    fi\n    \n    # Step 2: Format schema\n    echo \"📝 Formatting Prisma schema...\"\n    if npx prisma format; then\n        echo \"✅ Schema formatted successfully\"\n    else\n        echo \"⚠️ Schema formatting failed\"\n    fi\n    \n    # Step 3: Generate Prisma client\n    echo \"🏗️ Generating Prisma client...\"\n    if npx prisma generate; then\n        echo \"✅ Prisma client generated successfully\"\n    else\n        echo \"❌ Prisma client generation failed\"\n        exit 1\n    fi\n    \n    # Step 4: Create migration (dev mode only)\n    if [ \"$NODE_ENV\" != \"production\" ]; then\n        echo \"🗄️ Creating database migration...\"\n        MIGRATION_NAME=\"auto_migration_$(date +%Y%m%d_%H%M%S)\"\n        \n        if npx prisma migrate dev --name \"$MIGRATION_NAME\" --create-only; then\n            echo \"✅ Migration created: $MIGRATION_NAME\"\n            echo \"⚠️ Please review the migration before applying it to your database\"\n            echo \"💡 Apply with: npx prisma migrate dev\"\n        else\n            echo \"⚠️ Migration creation skipped or failed\"\n        fi\n    else\n        echo \"ℹ️ Production environment - skipping migration creation\"\n    fi\n    \n    echo \"\"\n    echo \"💡 Prisma Sync Tips:\"\n    echo \"  • Review generated migrations before applying\"\n    echo \"  • Use 'npx prisma studio' to explore your database\"\n    echo \"  • Run 'npx prisma db push' for prototyping\"\n    echo \"  • Use 'npx prisma migrate reset' to reset development database\"\n    \n    echo \"\"\n    echo \"🎯 Prisma schema sync complete!\"\n    \nelse\n    echo \"ℹ️ File is not a Prisma schema file: $FILE_PATH\"\nfi\n\nexit 0"
}

Features

Key capabilities and functionality

Automatic Prisma client generation
Database migration creation
Schema validation and formatting
TypeScript type generation
Database synchronization
Migration safety checks

Installation

Setup instructions and requirements

Claude Code Setup

Create hooks directory: mkdir -p .claude/hooks
Create hook script: .claude/hooks/prisma-schema-sync.sh
Add hook configuration to your Claude Code config
Make script executable: chmod +x .claude/hooks/prisma-schema-sync.sh
Restart Claude Code to activate the hook

Configuration Paths

project

.claude/hooks/

user

~/.claude/hooks/

Requirements

Claude Code CLI
Bash shell
Hook-specific dependencies (e.g., jq, prettier)

Hook Configuration

Hook setup and script content

post-tool-use-config.json

json

{
  "hooks": {
    "postToolUse": {
      "script": "./.claude/hooks/prisma-schema-sync.sh",
      "matchers": [
        "write",
        "edit"
      ]
    }
  }
}

post-tool-use-script.sh

bash

#!/bin/bash

# Read the tool input from stdin
INPUT=$(cat)
TOOL_NAME=$(echo "$INPUT" | jq -r '.tool_name')
FILE_PATH=$(echo "$INPUT" | jq -r '.tool_input.file_path // .tool_input.path // ""')

if [ -z "$FILE_PATH" ]; then
  exit 0
fi

# Check if this is a Prisma schema file
if [[ "$FILE_PATH" == *schema.prisma ]]; then
    echo "🔄 Prisma Schema Sync - Processing schema changes..."
    echo "📄 Schema file: $FILE_PATH"
    
    # Check if Prisma is available
    if ! command -v npx >/dev/null 2>&1; then
        echo "⚠️ npx not found. Please install Node.js and npm"
        exit 1
    fi
    
    # Step 1: Validate schema
    echo "🔍 Validating Prisma schema..."
    if npx prisma validate; then
        echo "✅ Schema validation passed"
    else
        echo "❌ Schema validation failed - Please fix errors before proceeding"
        exit 1
    fi
    
    # Step 2: Format schema
    echo "📝 Formatting Prisma schema..."
    if npx prisma format; then
        echo "✅ Schema formatted successfully"
    else
        echo "⚠️ Schema formatting failed"
    fi
    
    # Step 3: Generate Prisma client
    echo "🏗️ Generating Prisma client..."
    if npx prisma generate; then
        echo "✅ Prisma client generated successfully"
    else
        echo "❌ Prisma client generation failed"
        exit 1
    fi
    
    # Step 4: Create migration (dev mode only)
    if [ "$NODE_ENV" != "production" ]; then
        echo "🗄️ Creating database migration..."
        MIGRATION_NAME="auto_migration_$(date +%Y%m%d_%H%M%S)"
        
        if npx prisma migrate dev --name "$MIGRATION_NAME" --create-only; then
            echo "✅ Migration created: $MIGRATION_NAME"
            echo "⚠️ Please review the migration before applying it to your database"
            echo "💡 Apply with: npx prisma migrate dev"
        else
            echo "⚠️ Migration creation skipped or failed"
        fi
    else
        echo "ℹ️ Production environment - skipping migration creation"
    fi
    
    echo ""
    echo "💡 Prisma Sync Tips:"
    echo "  • Review generated migrations before applying"
    echo "  • Use 'npx prisma studio' to explore your database"
    echo "  • Run 'npx prisma db push' for prototyping"
    echo "  • Use 'npx prisma migrate reset' to reset development database"
    
    echo ""
    echo "🎯 Prisma schema sync complete!"
    
else
    echo "ℹ️ File is not a Prisma schema file: $FILE_PATH"
fi

exit 0

Use Cases

Common scenarios and applications

Keep Prisma client in sync with schema changes
Automatically create database migrations
Validate Prisma schema syntax on changes
Generate TypeScript types for database models
Format Prisma schema files consistently
Ensure database schema consistency
Streamline database development workflow
Catch schema errors early in development

Troubleshooting

Common issues and solutions

npx prisma generate fails with 'generator not found' error
Prisma client not installed or wrong version. Run: 'npm install @prisma/client' matching schema generator. Verify: 'npx prisma version' showing versions. Re-generate with full schema path.
Migration creation hangs waiting for database connection that fails
DATABASE_URL missing or incorrect in .env. Verify: 'echo $DATABASE_URL' showing connection. Test: 'npx prisma db pull' for connectivity. Or use '--skip-generate' flag bypassing DB.
Auto-migration creates duplicate migrations for identical schema changes
Timestamp-based naming always creates new migration. Add check: 'git diff prisma/schema.prisma | grep "^+model"' detecting real changes. Or use 'npx prisma migrate diff' to compare first.
prisma format changes schema but hook shows no modifications
Formatting occurs after file write completing hook execution. Move format before validation: reorder script or use: 'npx prisma format && npx prisma validate' ensuring formatted state checked.
Hook runs in production despite NODE_ENV check skipping migrations
NODE_ENV not set in deployment defaulting to undefined. Export: 'export NODE_ENV=production' in shell profile. Or check: 'if [ "$NODE_ENV" = "production" ] || [ -z "$NODE_ENV" ]'.

Reviews (0)

Sort by:

Loading reviews...

Automate with Claude Hooks

Get the latest automation hooks delivered weekly.

Join our community of Claude power users. No spam, unsubscribe anytime.

Claude Code Setup

Configuration Paths

Requirements

Reviews (0)

Category

Source

Accessibility Checker

API Endpoint Documentation Generator

Auto Code Formatter Hook