@aiready/consistency 0.3.4 → 0.3.5

package/.turbo/turbo-build.log

@@ -0,0 +1,24 @@
+
+
+> @aiready/consistency@0.3.5 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
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Target: es2020
+CJS Build start
+ESM Build start
+ESM dist/cli.mjs            8.54 KB
+ESM dist/index.mjs          220.00 B
+ESM dist/chunk-2BTBNG6X.mjs 21.88 KB
+ESM ⚡️ Build success in 70ms
+CJS dist/cli.js   32.02 KB
+CJS dist/index.js 23.13 KB
+CJS ⚡️ Build success in 71ms
+DTS Build start
+DTS ⚡️ Build success in 683ms
+DTS dist/cli.d.ts    20.00 B
+DTS dist/index.d.ts  2.60 KB
+DTS dist/cli.d.mts   20.00 B
+DTS dist/index.d.mts 2.60 KB

package/.turbo/turbo-test.log

@@ -0,0 +1,81 @@
+
+
+> @aiready/consistency@0.3.5 test /Users/pengcao/projects/aiready/packages/consistency
+> vitest run
+
+
+ RUN  v2.1.9 /Users/pengcao/projects/aiready/packages/consistency
+
+[?25l     · should detect minimum severity filtering
+   · 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
+     · 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
+[?25l     ✓ should detect minimum severity filtering
+   ✓ 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
+     ✓ 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)
+   ✓ analyzeConsistency (2)
+     ✓ should analyze naming issues
+     ✓ should detect minimum severity filtering
+   ✓ 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
+     ✓ 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
+
+ Test Files  1 passed (1)
+      Tests  18 passed (18)
+   Start at  18:28:56
+   Duration  729ms (transform 144ms, setup 0ms, collect 339ms, tests 28ms, environment 0ms, prepare 61ms)
+
+[?25h[?25h

package/README.md

@@ -32,11 +32,15 @@ Inconsistent code patterns confuse AI models and reduce their effectiveness. Thi
 - **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.)
+- Common abbreviations (env, api, url, max, min, now, etc.) - 100+ built-in
 - Boolean prefixes (is, has, can used as variables)
-- Loop iterators in appropriate contexts
+- 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)
@@ -127,7 +131,7 @@ aiready-consistency ./src --output markdown --output-file custom-report.md
 
 ## 📝 Configuration File
 
-Create `aiready.json` in your project root:
+Create `.airreadyrc.json`, `aiready.json`, or `aiready.config.json` in your project root:
 
 ```json
 {
@@ -139,7 +143,10 @@ Create `aiready.json` in your project root:
     "consistency": {
       "checkNaming": true,
       "checkPatterns": true,
-      "minSeverity": "minor"
+      "minSeverity": "minor",
+      "acceptedAbbreviations": ["ses", "gst", "cdk"],
+      "shortWords": ["oak", "elm"],
+      "disableChecks": []
     }
   },
   "output": {
@@ -155,17 +162,58 @@ Create `aiready.json` in your project root:
 | `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"]
+    }
+  }
+}
+```
+
+**E-commerce Projects:**
+```json
+{
+  "tools": {
+    "consistency": {
+      "acceptedAbbreviations": ["gst", "vat", "sku", "upc"],
+      "shortWords": ["tax", "buy", "pay", "cart"]
+    }
+  }
+}
+```
 
 ### Acceptable Abbreviations
 
-The tool recognizes 60+ standard abbreviations and won't flag them:
+The tool recognizes 100+ standard abbreviations and won't flag them:
 
-**Web/Network:** url, uri, api, cdn, dns, ip, http, utm, seo, xhr  
+**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  
+**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.