quality-standards

Quality Standards Rules

🎯 Overview

These rules enforce the quality standards defined in docs/QUALITY_STANDARDS.md.

Zero Tolerance:

• ❌ No as any type assertions
• ❌ No console.log/error (use StructuredLogger)
• ❌ No magic numbers (use constants)
• ❌ No code duplication (use utilities)
• ❌ No empty catch blocks

🔍 Code Searchability Patterns

Find Quality Issues with ast-grep

# Find 'as any' type assertions (CRITICAL)
ast-grep --pattern 'as any' src/
sg -p 'as any' src/

# Find console.log usage (should use StructuredLogger)
ast-grep --pattern 'console.$METHOD($$$)' src/
sg -p 'console.log' src/
sg -p 'console.error' src/

# Find magic numbers (should use constants)
ast-grep --pattern '$NUM' src/
sg -p '90' src/  # Example: find hardcoded 90
sg -p '5000' src/  # Example: find hardcoded 5000

# Find empty catch blocks
ast-grep --pattern 'catch ($VAR) { }' src/
sg -p 'catch' src/

# Find duplicate code patterns
ast-grep --pattern 'const $VAR = Date.now().toString(36)' src/
sg -p 'Date.now().toString' src/

Quality Enforcement Commands

# Run all quality checks
sg scan --filter "detect-type-assertion-any"
sg scan --filter "detect-console-in-source"
sg scan --filter "detect-magic-numbers"

# Find specific anti-patterns
sg search 'as any' src/
sg search 'console.log' src/
sg search 'Date.now().toString' src/

---

1. Type Safety - No 'as any'

❌ WRONG

const result = (await query.all()) as any;
const data = result.results || [];

const metrics = { ...testData } as any;

✅ CORRECT

// Use type guards
function isQueryResult(val: unknown): val is QueryResult {
  return typeof val === 'object' && val !== null && 'results' in val;
}

const result = await query.all();
const data = isQueryResult(result) ? result.results : [];

// Use utilities
import { normalizeD1Result } from '../utils/request';
const data = normalizeD1Result<MyType>(await query.all());

// Proper type definition
const metrics: CostCapMetrics = {
  requests: { current: 0, limit: TEST_LIMITS.REQUESTS, percentage: 0 },
  // ... all fields typed
};