@aiready/consistency 0.8.29 → 0.8.30

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/consistency@0.8.29 build /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.8.30 build /Users/pengcao/projects/aiready/packages/consistency
 > tsup src/index.ts src/cli.ts --format cjs,esm --dts
 
 CLI Building entry: src/cli.ts, src/index.ts
@@ -9,15 +9,15 @@
 CLI Target: es2020
 CJS Build start
 ESM Build start
-CJS dist/index.js 55.56 KB
-CJS dist/cli.js   50.90 KB
-CJS ⚡️ Build success in 245ms
 ESM dist/index.mjs          12.92 KB
-ESM dist/chunk-YEHXYHGY.mjs 40.95 KB
 ESM dist/cli.mjs            8.76 KB
-ESM ⚡️ Build success in 239ms
+ESM dist/chunk-YEHXYHGY.mjs 40.95 KB
+ESM ⚡️ Build success in 168ms
+CJS dist/cli.js   50.90 KB
+CJS dist/index.js 55.56 KB
+CJS ⚡️ Build success in 205ms
 DTS Build start
-DTS ⚡️ Build success in 11399ms
+DTS ⚡️ Build success in 9020ms
 DTS dist/cli.d.ts    20.00 B
 DTS dist/index.d.ts  3.41 KB
 DTS dist/cli.d.mts   20.00 B

package/.turbo/turbo-test.log

@@ -1,22 +1,24 @@
 
 
-> @aiready/consistency@0.8.29 test /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.8.30 test /Users/pengcao/projects/aiready/packages/consistency
 > vitest run
 
 [?25l
  RUN  v4.0.18 /Users/pengcao/projects/aiready/packages/consistency
 
  ✓ dist/__tests__/scoring.test.js (8 tests) 3ms
- ✓ src/__tests__/language-filter.test.ts (3 tests) 7ms
- ✓ dist/__tests__/language-filter.test.js (3 tests) 3ms
- ✓ src/__tests__/scoring.test.ts (8 tests) 4ms
- ✓ src/__tests__/analyzer.test.ts (18 tests) 722ms
-     ✓ should analyze naming issues  363ms
- ✓ dist/__tests__/analyzer.test.js (18 tests) 582ms
+ ✓ src/__tests__/scoring.test.ts (8 tests) 7ms
+ ✓ src/__tests__/language-filter.test.ts (3 tests) 5ms
+ ✓ dist/__tests__/language-filter.test.js (3 tests) 4ms
+ ✓ dist/__tests__/analyzer.test.js (18 tests) 1061ms
+     ✓ should analyze naming issues  494ms
+     ✓ should detect minimum severity filtering  372ms
+ ✓ src/__tests__/analyzer.test.ts (18 tests) 1009ms
+     ✓ should analyze naming issues  673ms
 
  Test Files  6 passed (6)
       Tests  58 passed (58)
-   Start at  22:34:02
-   Duration  1.92s (transform 874ms, setup 0ms, import 4.31s, tests 1.32s, environment 83ms)
+   Start at  13:04:30
+   Duration  4.31s (transform 3.85s, setup 0ms, import 13.17s, tests 2.09s, environment 4ms)
 
 [?25h

package/README.md

@@ -1,8 +1,13 @@
 # @aiready/consistency
 
-> **Detect consistency issues in naming, patterns, and architecture that confuse AI models**
+> AIReady Spoke: Scans for naming violations, architectural drift, and pattern mismatches that confuse AI agents.
 
-Helps teams maintain consistent coding practices across their codebase, making it easier for AI tools to understand and work with your code.
+[![npm version](https://img.shields.io/npm/v/@aiready/consistency.svg)](https://npmjs.com/package/@aiready/consistency)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## 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
 
@@ -10,349 +15,42 @@ Helps teams maintain consistent coding practices across their codebase, making i
                     🎯 USER
                       │
                       ▼
-            🎛️  CLI (orchestrator)
-                      │
-    ┌─────────────────┴─────────────────┐
-    │                                   │
-    ▼                                   ▼
-┌────────┐                        ┌────────┐
-│🎨 VIS- │                        │ ANALY- │
-│UALIZER │                        │  SIS   │
-│✅ Ready│                        │ SPOKES │
-└────────┘                        └───┬────┘
-    │                                 │
-    │           ┌─────────────────────┼─────────────────────┐
-    │           ▼                     ▼                     ▼
-    │     ┌────────┐           ┌────────┐           ┌────────┐
-    │     │📊 PAT- │           │📦 CON- │           │🔧 CON- │
-    │     │TERN    │           │TEXT    │           │SISTENCY│
-    │     │DETECT  │           │ANALYZER│           │        │
-    │     │        │           │        │           │        │
-    │     │✅ Ready│           │✅ Ready│           │✅ Ready│
-    │     └────────┘           └────────┘           └────────┘
-    │                                                       │
-    │                                  ← YOU ARE HERE ──────┘
-    │                                                       │
-    └───────────────────────────────────────────────────────┘
-                            │
-                            ▼
-                  🏢 HUB (@aiready/core)
-```
-
-## 🌍 Language Support
-
-**Currently Supported (64% market coverage):**
-- ✅ **TypeScript** (`.ts`, `.tsx`) - camelCase, PascalCase conventions
-- ✅ **JavaScript** (`.js`, `.jsx`) - camelCase, PascalCase conventions
-- ✅ **Python** (`.py`) - PEP 8 conventions (snake_case, PascalCase, UPPER_CASE)
-
-**Roadmap:**
-- 🔜 **Java** (Q3 2026) - Java naming conventions, JavaBean patterns
-- 🔜 **Go** (Q4 2026) - Go naming conventions, exported names
-- 🔜 **Rust** (Q4 2026) - Rust naming conventions, snake_case
-- 🔜 **C#** (Q1 2027) - C# conventions, PascalCase
-
-## 🚀 Quick Start
-
-**Zero config, works out of the box:**
-
-```bash
-# Run without installation (recommended)
-npx @aiready/consistency ./src
+         🎛️  @aiready/cli (orchestrator)
+          │     │     │     │     │     │     │     │     │
+          ▼     ▼     ▼     ▼     ▼     ▼     ▼     ▼     ▼
+        [PAT] [CTX] [CON] [AMP] [DEP] [DOC] [SIG] [AGT] [TST]
+          │     │     │     │     │     │     │     │     │
+          └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
+                               │
+                               ▼
+                      🏢 @aiready/core
 
-# Or use the unified CLI (includes all AIReady tools)
-npx @aiready/cli scan ./src
-
-# Or install globally for simpler command and faster runs
-npm install -g @aiready/consistency
-aiready-consistency ./src
-```
-
-### 🎯 Input & Output
-
-**Input:** Path to your source code directory
-```bash
-aiready-consistency ./src
+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
 ```
 
-**Output:** Terminal report + optional JSON file (saved to `.aiready/` directory)
-```
-📊 Consistency Analysis
-━━━━━━━━━━━━━━━━━━━━━━━━
-📁 Files analyzed: 47
-⚠️  Issues found: 15 naming + 8 pattern issues
-
-CRITICAL (2 files)
-  src/utils/helpers.ts:12 - poor-naming: x
-  src/api/users.ts:45 - convention-mix: user_name
-```
-
-### ✨ Smart Defaults (Zero Config)
-
-- ✅ **Auto-excludes** test files (`**/*.test.*`, `**/*.spec.*`, `**/__tests__/**`)
-- ✅ **Auto-excludes** build outputs (`dist/`, `build/`, `.next/`)
-- ✅ **Auto-excludes** dependencies (`node_modules/`)
-- ✅ **Context-aware**: Skips common iterators (i, j, k) in loops
-- ✅ **100+ built-in** acceptable abbreviations (env, api, url, ctx, etc.)
-- ✅ **Smart detection**: Recognizes arrow functions, factory patterns, callbacks
-
-> Override defaults with `--include-tests` or `--exclude <patterns>` as needed
-
-## 🎯 What It Does
-
-Inconsistent code patterns confuse AI models and reduce their effectiveness. This tool analyzes:
-
-### 🔧 Language Support
-
-**Fully Supported:**
-- TypeScript (`.ts`, `.tsx`)
-- JavaScript (`.js`, `.jsx`)
-
-**Not Yet Supported:**
-- Python (`.py`) - Files will be skipped
-- Java (`.java`) - Files will be skipped
-- Other languages - Files will be skipped
-
-If you see "Failed to parse" warnings for non-JS/TS files, this is expected behavior and won't affect the analysis of your JavaScript/TypeScript code.
-
-### 🏷️ Naming Quality & Conventions
-- **Single-letter variables** - Detects unclear variable names (skips common iterators: i, j, k, l, x, y, z in appropriate contexts)
-- **Abbreviations** - Identifies unclear abbreviations while allowing 60+ standard ones (env, req, res, ctx, max, min, etc.)
-- **Mixed naming conventions** - Detects snake_case in TypeScript/JavaScript projects (should use camelCase)
-- **Boolean naming** - Ensures booleans use clear prefixes (is/has/can/should)
-- **Function naming** - Checks for action verbs while allowing factory patterns and descriptive names
-
-**Smart Detection:** The tool understands context and won't flag:
-- Common abbreviations (env, api, url, max, min, now, etc.) - 100+ built-in
-- Boolean prefixes (is, has, can used as variables)
-- Loop iterators (i, j, k) in appropriate contexts
-- Arrow function parameters in callbacks (`.map(s => ...)`)
-- Multi-line arrow functions (detects across 3-5 line context)
-- Short-lived comparison variables (used within 5 lines)
-- Factory/builder patterns
-- Long descriptive function names
-- Project-specific abbreviations via configuration
-
-### 🔄 Pattern Consistency
-- **Error handling strategies** - Detects mixed approaches (try-catch vs returns vs throws)
-- **Async patterns** - Identifies mixing of async/await, promises, and callbacks
-- **Import styles** - Flags mixing of ES modules and CommonJS
-- **API design patterns** - Ensures consistent patterns across endpoints
-
-### 🏗️ Architectural Consistency *(coming soon)*
-- File organization patterns
-- Module structure
-- Export/import patterns
-
-## 📊 Example Output
-
-```
-📊 Summary
-
-Files Analyzed: 47
-Total Issues: 23
-  Naming: 15
-  Patterns: 8
-  Architecture: 0
-
-🏷️  Naming Issues
-
-MINOR src/utils/helpers.ts:12
-  poor-naming: x
-  → Use descriptive variable name instead of single letter 'x'
-
-MINOR src/components/User.ts:45
-  convention-mix: user_name
-  → Use camelCase 'userName' instead of snake_case in TypeScript/JavaScript
-
-🔄 Pattern Issues
-
-MAJOR multiple files
-  Inconsistent error handling strategies across codebase
-  → Standardize error handling strategy (prefer try-catch with typed errors)
+## Features
 
-💡 Recommendations
+- **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.
 
-1. Standardize naming conventions: Found 7 snake_case variables in TypeScript
-2. Improve variable naming: Found 8 single-letter or unclear variable names
-3. Use async/await consistently instead of mixing with promise chains
-```
-
-## ⚙️ Usage
+## Installation
 
 ```bash
-# Full analysis
-aiready-consistency ./src
-
-# Skip naming checks
-aiready-consistency ./src --no-naming
-
-# Skip pattern checks
-aiready-consistency ./src --no-patterns
-
-# Show only major issues
-aiready-consistency ./src --min-severity major
-
-# Export to JSON (saved to .aiready/ by default)
-aiready-consistency ./src --output json
-
-# Export to Markdown (saved to .aiready/ by default)
-aiready-consistency ./src --output markdown
-
-# Or specify custom paths
-aiready-consistency ./src --output json --output-file custom-report.json
-aiready-consistency ./src --output markdown --output-file custom-report.md
+pnpm add @aiready/consistency
 ```
 
-> **📁 Output Files:** By default, all output files are saved to the `.aiready/` directory in your project root with timestamped filenames. You can override this with `--output-file`.
-
-## 🎛️ Options
-
-| Option | Description | Default |
-|--------|-------------|---------|
-| `--naming` | Enable naming analysis | `true` |
-| `--no-naming` | Skip naming analysis | - |
-| `--patterns` | Enable pattern analysis | `true` |
-| `--no-patterns` | Skip pattern analysis | - |
-| `--min-severity` | Minimum severity: info\|minor\|major\|critical | `info` |
-| `--include` | File patterns to include | All files |
-| `--exclude` | File patterns to exclude | - |
-| `--output` | Output format: console\|json\|markdown | `console` |
-| `--output-file` | Output file path | - |
-
-## 📝 Configuration File
-
-Create `.airreadyrc.json`, `aiready.json`, or `aiready.config.json` in your project root:
-
-```json
-{
-  "scan": {
-    "include": ["src/**/*.{ts,tsx,js,jsx}"],
-    "exclude": ["**/dist/**", "**/node_modules/**"]
-  },
-  "tools": {
-    "consistency": {
-      "checkNaming": true,
-      "checkPatterns": true,
-      "minSeverity": "minor",
-      "acceptedAbbreviations": ["ses", "gst", "cdk"],
-      "shortWords": ["oak", "elm"],
-      "disableChecks": []
-    }
-  },
-  "output": {
-    "format": "console"
-  }
-}
-```
-
-**Configuration Options:**
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `checkNaming` | boolean | `true` | Check naming conventions |
-| `checkPatterns` | boolean | `true` | Check code pattern consistency |
-| `minSeverity` | string | `'info'` | Filter: `'info'`, `'minor'`, `'major'`, `'critical'` |
-| `acceptedAbbreviations` | string[] | `[]` | Custom abbreviations to accept (e.g., domain-specific terms) |
-| `shortWords` | string[] | `[]` | Additional full English words to accept |
-| `disableChecks` | string[] | `[]` | Disable specific checks: `'single-letter'`, `'abbreviation'`, `'convention-mix'`, `'unclear'`, `'poor-naming'` |
-
-### Project-Specific Configuration Examples
-
-**React/Next.js Projects:**
-```json
-{
-  "tools": {
-    "consistency": {
-      "acceptedAbbreviations": ["jsx", "tsx", "ref", "ctx", "req", "res"]
-    }
-  }
-}
-```
-
-**AWS/Cloud Projects:**
-```json
-{
-  "tools": {
-    "consistency": {
-      "acceptedAbbreviations": ["ses", "sns", "sqs", "ec2", "vpc", "iam"]
-    }
-  }
-}
-```
+## Usage
 
-**E-commerce Projects:**
-```json
-{
-  "tools": {
-    "consistency": {
-      "acceptedAbbreviations": ["gst", "vat", "sku", "upc"],
-      "shortWords": ["tax", "buy", "pay", "cart"]
-    }
-  }
-}
-```
-
-### Acceptable Abbreviations
-
-The tool recognizes 100+ standard abbreviations and won't flag them:
-
-**Web/Network:** url, uri, api, cdn, dns, ip, http, utm, seo, xhr, cors, ws, wss  
-**Data:** json, xml, yaml, csv, html, css, svg, pdf, dto, dao  
-**System:** env, os, fs, cli, tmp, src, dst, bin, lib, pkg  
-**Request/Response:** req, res, ctx, err, msg  
-**Math:** max, min, avg, sum, abs, cos, sin, log, sqrt  
-**Time:** now, utc, ms, sec, hr, yr, mo  
-**Loop Counters:** i, j, k, n, m  
-**Cloud/Infrastructure:** s3, ec2, sqs, sns, vpc, ami, iam, aws  
-**Common:** id, uid, db, sql, orm, ui, ux, dom, ref, val, str, obj, arr, cfg, init
-
-See [naming.ts](src/analyzers/naming.ts) for the complete list.
-
-## 🔧 Programmatic API
-
-```typescript
-import { analyzeConsistency } from '@aiready/consistency';
-
-const report = await analyzeConsistency({
-  rootDir: './src',
-  checkNaming: true,
-  checkPatterns: true,
-  minSeverity: 'minor'
-});
-
-console.log(`Found ${report.summary.totalIssues} issues`);
+```bash
+aiready scan . --tools consistency
 ```
 
-## 🤝 Why This Matters for AI
-
-AI models work best with consistent codebases because:
-
-1. **Pattern Recognition**: Consistent patterns help AI understand your coding style
-2. **Context Efficiency**: Less variation = more useful code fits in context window
-3. **Accurate Suggestions**: AI can predict conventions and follow them
-4. **Reduced Errors**: AI makes fewer mistakes with clear, consistent patterns
-
-## 📦 Integration with AIReady
-
-This tool is part of the [AIReady](https://getaiready.dev) ecosystem:
-
-**Related packages:**
-- [**@aiready/cli**](https://www.npmjs.com/package/@aiready/cli) - Unified interface for all analysis tools
-- [**@aiready/pattern-detect**](https://www.npmjs.com/package/@aiready/pattern-detect) - Semantic duplicate detection
-- [**@aiready/context-analyzer**](https://www.npmjs.com/package/@aiready/context-analyzer) - Context window cost analysis
-- **@aiready/context-analyzer** - Context window cost analysis
-- **@aiready/consistency** - Consistency analysis (this tool)
-
-## 📖 Documentation
-
-- [Contributing Guide](./CONTRIBUTING.md)
-- [AIReady Website](https://getaiready.dev)
-
-## 🌐 Visit Our Website
-
-**Try AIReady tools online and maintain code consistency:** [getaiready.dev](https://getaiready.dev)
-
-## 📄 License
+## License
 
-MIT © AIReady Team
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/consistency",
-  "version": "0.8.29",
+  "version": "0.8.30",
   "description": "Detects consistency issues in naming, patterns, and architecture that confuse AI models",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -43,7 +43,7 @@
     "@typescript-eslint/typescript-estree": "^8.53.0",
     "chalk": "^5.3.0",
     "commander": "^14.0.0",
-    "@aiready/core": "0.9.30"
+    "@aiready/core": "0.9.31"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",