@aiready/consistency

AIReady Spoke: Scans for naming violations, architectural drift, and pattern mismatches that confuse AI agents.

Overview

Consistent naming and project structure are the bedrock of high-performing AI teams. The Consistency analyzer scans your project for naming violations, architectural drift, and pattern mismatches that slow down AI agents.

🏛️ Architecture

                    🎯 USER
                      │
                      ▼
         🎛️  @aiready/cli (orchestrator)
          │     │     │     │     │     │     │     │     │
          ▼     ▼     ▼     ▼     ▼     ▼     ▼     ▼     ▼
        [PAT] [CTX] [CON] [AMP] [DEP] [DOC] [SIG] [AGT] [TST]
          │     │     │     │     │     │     │     │     │
          └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
                               │
                               ▼
                      🏢 @aiready/core

Legend:
  PAT = pattern-detect        CTX = context-analyzer
  CON = consistency ★         AMP = change-amplification
  DEP = deps-health           DOC = doc-drift
  SIG = ai-signal-clarity     AGT = agent-grounding
  TST = testability           ★   = YOU ARE HERE

Features

• Naming Conventions: Enforces consistent naming for files, classes, and variables.
• Architectural Guardrails: Ensures components stay within their defined layer (e.g., spokes don't import from other spokes).
• Pattern Matcher: Detects if new code follows established project patterns.

Installation

pnpm add @aiready/consistency

Usage

aiready scan . --tools consistency

License

MIT