pre-commit-workflow

Pre-Commit Workflow

Before committing any changes to lightfast-mcp, execute this comprehensive validation workflow:

Mandatory Pre-Commit Steps

1. Format and Lint: Ensure code style compliance
2. Run Tests: Execute comprehensive test suite
3. Validate Configs: Check all configuration files
4. Test Server Startup: Verify servers can start
5. Security Check: Run security validation
6. Type Check: Ensure type safety

Automatic Pre-Commit Commands

Run this command sequence before every commit:

#!/bin/bash
echo "🚀 Running lightfast-mcp pre-commit checks..."

# Step 1: Format and Lint
echo "📝 Step 1: Formatting and linting..."
uv run task format
uv run task lint

# Step 2: Fast tests for immediate feedback
echo "⚡ Step 2: Running fast tests..."
nox -s test_fast

# Step 3: Configuration validation
echo "⚙️  Step 3: Validating configurations..."
find config -name "*.yaml" -exec python -c "import yaml; yaml.safe_load(open('{}'))" \; 2>/dev/null
find . -name "*.json" -exec python -c "import json; json.load(open('{}'))" \; 2>/dev/null
echo "✅ Configuration files validated"

# Step 4: Test server startup
echo "🏁 Step 4: Testing server startup..."
timeout 10 uv run lightfast-mock-server &
MOCK_PID=$!
sleep 3
kill $MOCK_PID 2>/dev/null || true
echo "✅ Mock server startup tested"

# Step 5: System integration test
echo "🧪 Step 5: System integration test..."
nox -s verify_system

# Step 6: Type checking
echo "🔍 Step 6: Type checking..."
nox -s typecheck

# Step 7: Security check
echo "🔒 Step 7: Security check..."
python -m py_compile $(find src -name "*.py")
echo "✅ Python compilation successful"

echo "✨ All pre-commit checks passed!"

File-Type Specific Validations

For Server File Changes

# Additional checks when server files are modified
echo "🖥️  Server-specific validations..."

# Test MCP protocol compliance
uv run pytest tests/unit/test_*server*.py -v

# Validate tool decorators and signatures
python -c "
import ast
import glob
for file in glob.glob('src/lightfast_mcp/servers/**/*.py', recursive=True):
    with open(file) as f:
        tree = ast.parse(f.read())
        # Check for @mcp.tool() decorators
        print(f'Validated: {file}')
"