@aiready/consistency 0.6.5 → 0.6.7

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/consistency@0.6.5 build /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.6.7 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,16 +9,16 @@
 CLI Target: es2020
 CJS Build start
 ESM Build start
-ESM dist/chunk-ON73WHHU.mjs 34.85 KB
-ESM dist/index.mjs          14.04 KB
+CJS dist/index.js 46.99 KB
+CJS dist/cli.js   45.90 KB
+CJS ⚡️ Build success in 55ms
 ESM dist/cli.mjs            8.55 KB
-ESM ⚡️ Build success in 40ms
-CJS dist/cli.js   45.11 KB
-CJS dist/index.js 50.15 KB
-CJS ⚡️ Build success in 40ms
+ESM dist/index.mjs          9.73 KB
+ESM dist/chunk-WTBDNCEN.mjs 36.20 KB
+ESM ⚡️ Build success in 55ms
 DTS Build start
-DTS ⚡️ Build success in 1037ms
+DTS ⚡️ Build success in 1008ms
 DTS dist/cli.d.ts    20.00 B
-DTS dist/index.d.ts  2.73 KB
+DTS dist/index.d.ts  2.77 KB
 DTS dist/cli.d.mts   20.00 B
-DTS dist/index.d.mts 2.73 KB
+DTS dist/index.d.mts 2.77 KB

package/.turbo/turbo-test.log

@@ -1,12 +1,13 @@
 
 
-> @aiready/consistency@0.6.5 test /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.6.7 test /Users/pengcao/projects/aiready/packages/consistency
 > vitest run
 
 
  RUN  v2.1.9 /Users/pengcao/projects/aiready/packages/consistency
 
-[?25l     · should detect single letter variables
+[?25l   · analyzeNaming (8)
+     · should detect single letter variables
      · should NOT flag acceptable abbreviations
      · should NOT flag common short English words
      · should detect snake_case in TypeScript files
@@ -25,26 +26,7 @@
      · should generate relevant recommendations
      · should suggest standardizing error handling
      · should suggest using async/await consistently
-[?25l[?25l[?25l[?25l[?25l[?25l[?25l     ✓ should detect single letter variables
-     ✓ should NOT flag acceptable abbreviations
-     ✓ should NOT flag common short English words
-     ✓ should detect snake_case in TypeScript files
-     ✓ should detect unclear boolean names
-     ✓ should allow common abbreviations
-     ✓ should NOT flag multi-line arrow function parameters (Phase 3)
-     ✓ should NOT flag short-lived comparison variables (Phase 3)
-   ✓ analyzePatterns (3)
-     ✓ should detect mixed error handling
-     ✓ should detect mixed async patterns
-     ✓ should detect mixed import styles
-   ✓ consistency scoring (2)
-     ✓ should calculate consistency score correctly
-     ✓ should weight critical issues more than info
-   ✓ recommendations (3)
-     ✓ should generate relevant recommendations
-     ✓ should suggest standardizing error handling
-     ✓ should suggest using async/await consistently
- ✓ src/__tests__/analyzer.test.ts (18)
+[?25l[?25l[?25l[?25l[?25l[?25l[?25l ✓ src/__tests__/analyzer.test.ts (18)
    ✓ analyzeConsistency (2)
      ✓ should analyze naming issues
      ✓ should detect minimum severity filtering
@@ -71,7 +53,7 @@
 
  Test Files  1 passed (1)
       Tests  18 passed (18)
-   Start at  01:15:32
-   Duration  615ms (transform 90ms, setup 0ms, collect 263ms, tests 130ms, environment 0ms, prepare 47ms)
+   Start at  18:32:20
+   Duration  616ms (transform 97ms, setup 0ms, collect 259ms, tests 138ms, environment 0ms, prepare 47ms)
 
 [?25h[?25h

package/README.md

@@ -6,20 +6,50 @@ Helps teams maintain consistent coding practices across their codebase, making i
 
 ## 🚀 Quick Start
 
-**Recommended: Use the unified CLI** (includes consistency checking + more tools):
+**Zero config, works out of the box:**
 
 ```bash
-npm install -g @aiready/cli
-aiready consistency ./src
+# Run without installation (recommended)
+npx @aiready/consistency ./src
+
+# 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
 ```
 
-**Or use this package directly:**
+### 🎯 Input & Output
 
+**Input:** Path to your source code directory
 ```bash
-npm install -g @aiready/consistency
 aiready-consistency ./src
 ```
 
+**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:
@@ -258,6 +288,10 @@ This tool is part of the [AIReady](https://github.com/caopengau/aiready) ecosyst
 - [Contributing Guide](./CONTRIBUTING.md)
 - [AIReady Main Repo](https://github.com/caopengau/aiready)
 
+## 🌐 Visit Our Website
+
+**Try AIReady tools online and maintain code consistency:** [getaiready.dev](https://getaiready.dev)
+
 ## 📄 License
 
 MIT © AIReady Team