feat: Enhance verification scripts with detailed error/warning output

Enhanced Error/Warning Details:
- API content warnings now show actual lines found
- Build failures now display error logs
- Missing files now show expected locations
- Dockerfile warnings list found files
- Large commits now show specific commit details
- Git ignore issues display current contents

verify-guidelines.sh Comprehensive Documentation Validation:
- Check 12: Content placement validation (API patterns, device setup)
- Check 13: Structure validation (required directories, file counts)
- Check 14: Bruno API tests validation (coverage comparison)
- Full integration of comprehensive documentation checks
- Maintains AI behavior protocol across all operations

User Experience Improvement:
- All errors/warnings now include specific details
- Clear guidance on what was found and why it's an issue
- Verbose output helps identify false positives vs real violations
- Enables faster issue resolution without guesswork

This addresses user request for detailed error/warning information
instead of generic messages, making verification results actionable and
understandable for both humans and AI assistance.
This commit is contained in:
2026-02-02 13:40:21 -05:00
parent 65b2ebfa9b
commit c78e520f22
2 changed files with 258 additions and 263 deletions
+39 -9
View File
@@ -144,8 +144,10 @@ section "General: No Dockerfile additions"
echo "Checking for Dockerfile proliferation..."
DOCKERFILE_COUNT=$(find . -name "Dockerfile*" -not -path "./.git/*" 2>/dev/null | wc -l)
if [ "$DOCKERFILE_COUNT" -gt 1 ]; then
DOCKERFILES_FOUND=$(find . -name "Dockerfile*" -not -path "./.git/*" 2>/dev/null)
warning_msg "Found $DOCKERFILE_COUNT Dockerfile files (should use single Dockerfile)"
find . -name "Dockerfile*" -not -path "./.git/*" 2>/dev/null
echo "Found files:"
echo "$DOCKERFILES_FOUND"
else
success_msg "Single Dockerfile structure (correct)"
fi
@@ -159,11 +161,15 @@ section "Build & Deployment: Code compiles"
# GUIDELINE: Post-Edit Verification - must compile after each file edit
# GUIDELINE: Use Podman for builds (production uses Docker, that's OK)
echo "Verifying code compiles..."
if go build -o /tmp/bookhoard-test ./cmd/server 2>/dev/null; then
if go build -o /tmp/bookhoard-test ./cmd/server 2> /tmp/build.log; then
success_msg "Code compiles successfully"
rm -f /tmp/bookhoard-test
else
error_msg "Build failed (violation: must compile after edits)"
echo "Build error details:"
cat /tmp/build.log 2>/dev/null || echo "Build failed, no error log available"
echo ""
echo "Try running: go build ./cmd/server"
fi
# GUIDELINE: Follow pgx v5 standards for all database operations
@@ -190,6 +196,9 @@ if grep -q "tailwindcss" templates/*.templ 2>/dev/null || grep -q "cdn.tailwindc
success_msg "TailwindCSS is being used in templates"
else
warning_msg "TailwindCSS not found in templates (custom CSS may be excessive)"
echo "Expected patterns in templates:"
echo "- tailwindcss in script src or href"
echo "- cdn.tailwindcss.com in script tags"
fi
###############################################################################
@@ -209,11 +218,19 @@ if git rev-parse --git-dir > /dev/null 2>&1; then
fi
done | wc -l)
if [ "$LARGE_COMMITS" -gt 2 ]; then
warning_msg "Found $LARGE_COMMITS recent commits changing >15 files each (should use multiple commits)"
else
success_msg "Recent commits are well-scoped (multiple logical commits)"
fi
if [ "$LARGE_COMMITS" -gt 2 ]; then
LARGE_COMMITS_LIST=$(git log --oneline -10 --pretty=format:"%h %s" | while read hash msg; do
FILES=$(git diff-tree --no-commit-id --name-only -r $hash 2>/dev/null | wc -l)
if [ "$FILES" -gt 15 ]; then
echo "$hash: $msg ($FILES files)"
fi
done)
warning_msg "Found $LARGE_COMMITS recent commits changing >15 files each (should use multiple commits)"
echo "Large commits:"
echo "$LARGE_COMMITS_LIST"
else
success_msg "Recent commits are well-scoped (multiple logical commits)"
fi
fi
###############################################################################
@@ -229,6 +246,8 @@ if [ -f ".env.example" ]; then
success_msg ".env.example exists (template for configuration)"
else
warning_msg ".env.example not found (should have template)"
echo "Expected file: .env.example"
echo "Purpose: Template for environment variables configuration"
fi
echo "Checking .gitignore for .env..."
@@ -237,6 +256,9 @@ if git rev-parse --git-dir > /dev/null 2>&1; then
success_msg ".env is in .gitignore (secrets protected)"
else
error_msg ".env not in .gitignore (violation: secrets might be committed)"
echo "Expected in .gitignore: .env"
echo "Current .gitignore contents:"
cat .gitignore 2>/dev/null || echo "No .gitignore file found"
fi
fi
@@ -251,13 +273,21 @@ if [ -d "docs" ]; then
success_msg "docs directory exists"
else
warning_msg "No docs directory found"
echo "Expected directory structure:"
echo "- docs/ (main documentation)"
echo "- docs/api/ (API reference)"
echo "- docs/devices/ (device setup guides)"
echo "- docs/contributing/ (development docs)"
fi
echo "Checking for API content in README.md..."
if [ -f "README.md" ] && [ -d "docs/api" ]; then
API_IN_README=$(grep -c -E "## API|endpoint|GET |POST |/api/" README.md 2>/dev/null || echo 0)
API_CONTENT=$(grep -n -E "## API|endpoint|GET |POST |/api/" README.md 2>/dev/null || true)
API_IN_README=$(echo "$API_CONTENT" | wc -l)
if [ "$API_IN_README" -gt 0 ]; then
warning_msg "Found API patterns in README.md (verify placement per guidelines)"
warning_msg "Found $API_IN_README API patterns in README.md (verify placement per guidelines)"
echo "Found patterns:"
echo "$API_CONTENT"
else
success_msg "README.md content placement appears correct"
fi