diff --git a/scripts/README.md b/scripts/README.md index 89061ec..c555473 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -132,17 +132,112 @@ The specific patterns found are: Do you want me to fix this? [y/n]" ``` +#### Complete Enhanced Output Examples: + +##### 1. Build Failure with Detailed Errors: +```bash +❌ ERROR: Build failed (violation: must compile after edits) + AI INSTRUCTION: Ask user before fixing this issue +Build error details: +# cmd/server/main.go:45:2: syntax error: unexpected newline, expecting } +# +# Try running: go build ./cmd/server +``` + +##### 2. Missing Configuration Files: +```bash +❌ ERROR: .env not in .gitignore (violation: secrets might be committed) + AI INSTRUCTION: Ask user before fixing this issue +Expected in .gitignore: .env +Current .gitignore contents: +# Binaries +bookhoard +server +*.exe +# Dependencies +node_modules/ +# Build artifacts +dist/ +build/ +*.log +``` + +##### 3. API Content Detection with Line Numbers: +```bash +⚠ WARNING: Found 2 API patterns in README.md (verify placement per guidelines) + AI INSTRUCTION: Ask user before fixing this issue +Found patterns: +81:- **Rate Limiting**: 10 requests/minute on auth endpoints +98:- **[docs/api/WEBSOCKET_API.md](docs/api/WEBSOCKET_API.md)** - WebSocket protocol +``` + +##### 4. File Organization Violations: +```bash +❌ ERROR: Found 3 .js files (violation: JavaScript prohibited, use TypeScript) + AI INSTRUCTION: Ask user before fixing this issue +Found files: +./web/static/header.js +./web/static/search.js +./scripts/legacy-migration.js +``` + +##### 5. Documentation Structure Validation: +```bash +✓ PASS: docs/api directory exists +✓ PASS: docs/devices directory missing +✓ PASS: docs/contributing directory exists + +⚠ WARNING: docs/devices directory missing + AI INSTRUCTION: Ask user before fixing this issue +Expected directory structure: +- docs/ (main documentation) +- docs/api/ (API reference) +- docs/devices/ (device setup guides) +- docs/contributing/ (development docs) +``` + +##### 6. Bruno API Tests Coverage Analysis: +```bash +✓ PASS: Found 47 Bruno test files +⚠ WARNING: Bruno test files (47) fewer than API docs (52) + AI INSTRUCTION: Ask user before fixing this issue +Coverage gap: API docs (52) vs Bruno tests (47) +``` + +##### 7. Git Commit Quality Analysis: +```bash +⚠ WARNING: Found 3 recent commits changing >15 files each (should use multiple commits) + AI INSTRUCTION: Ask user before fixing this issue +Large commits: +a1b2c3d: feat: add user authentication (18 files) +f4e5d6a: refactor: update database schema (22 files) +b7c8f9e: fix: resolve merge conflicts (16 files) +``` + +##### 8. CSS Template Violations: +```bash +❌ ERROR: Found 12 templates with +# With: