@aiready/consistency 0.6.8 → 0.6.10

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/consistency@0.6.8 build /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.6.10 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 47.29 KB
-CJS dist/cli.js   46.58 KB
-CJS ⚡️ Build success in 99ms
-ESM dist/cli.mjs            8.55 KB
-ESM dist/index.mjs          9.40 KB
+ESM dist/cli.mjs            8.62 KB
 ESM dist/chunk-HPG7P6PD.mjs 36.87 KB
-ESM ⚡️ Build success in 99ms
+ESM dist/index.mjs          9.40 KB
+ESM ⚡️ Build success in 214ms
+CJS dist/index.js 47.29 KB
+CJS dist/cli.js   46.65 KB
+CJS ⚡️ Build success in 216ms
 DTS Build start
-DTS ⚡️ Build success in 1083ms
+DTS ⚡️ Build success in 2193ms
 DTS dist/cli.d.ts    20.00 B
 DTS dist/index.d.ts  2.77 KB
 DTS dist/cli.d.mts   20.00 B

package/.turbo/turbo-test.log

@@ -1,12 +1,14 @@
 
 
-> @aiready/consistency@0.6.8 test /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.6.10 test /Users/pengcao/projects/aiready/packages/consistency
 > vitest run
 
 
  RUN  v2.1.9 /Users/pengcao/projects/aiready/packages/consistency
 
-[?25l     · should detect unclear boolean names
+[?25l     · 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)
@@ -21,7 +23,9 @@
      · should generate relevant recommendations
      · should suggest standardizing error handling
      · should suggest using async/await consistently
-[?25l[?25l[?25l[?25l[?25l[?25l[?25l     ✓ should detect unclear boolean names
+[?25l[?25l[?25l[?25l[?25l[?25l[?25l[?25l[?25l[?25l[?25l     ✓ 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)
@@ -36,7 +40,46 @@
      ⠙ should generate relevant recommendations
      · should suggest standardizing error handling
      · should suggest using async/await consistently
- ✓ src/__tests__/analyzer.test.ts (18)
+ ✓ 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  19:03:23
+   Duration  2.62s (transform 200ms, setup 0ms, collect 845ms, tests 224ms, environment 0ms, prepare 205ms)
+
+[?25h[?25h
+    ✓ 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
@@ -63,7 +106,7 @@
 
  Test Files  1 passed (1)
       Tests  18 passed (18)
-   Start at  20:58:11
-   Duration  769ms (transform 126ms, setup 0ms, collect 331ms, tests 135ms, environment 0ms, prepare 55ms)
+   Start at  19:03:23
+   Duration  2.34s (transform 239ms, setup 0ms, collect 994ms, tests 252ms, environment 0ms, prepare 141ms)
 
 [?25h[?25h

package/dist/cli.js

@@ -1387,7 +1387,7 @@ var import_fs2 = require("fs");
 var import_path2 = require("path");
 var import_core4 = require("@aiready/core");
 var program = new import_commander.Command();
-program.name("aiready-consistency").description("Detect consistency issues in naming, patterns, and architecture").version("0.1.0").addHelpText("after", `
+program.name("aiready-consistency").description("Detect consistency patterns in naming, code structure, and architecture").version("0.1.0").addHelpText("after", `
 CONFIGURATION:
   Supports config files: aiready.json, aiready.config.json, .aiready.json, .aireadyrc.json
   CLI options override config file settings
@@ -1400,7 +1400,7 @@ ANALYSIS CATEGORIES:
 EXAMPLES:
   aiready-consistency .                               # Full analysis
   aiready-consistency . --no-naming                   # Skip naming checks
-  aiready-consistency . --min-severity major          # Only show major+ issues
+  aiready-consistency . --min-severity major          # Only show major+ patterns
   aiready-consistency . --output json > report.json   # JSON export
 `).argument("<directory>", "Directory to analyze").option("--naming", "Check naming conventions and quality (default: true)").option("--no-naming", "Skip naming analysis").option("--patterns", "Check code pattern consistency (default: true)").option("--no-patterns", "Skip pattern analysis").option("--architecture", "Check architectural consistency (not yet implemented)").option("--min-severity <level>", "Minimum severity: info|minor|major|critical. Default: info").option("--include <patterns>", "File patterns to include (comma-separated)").option("--exclude <patterns>", "File patterns to exclude (comma-separated)").option("-o, --output <format>", "Output format: console|json|markdown", "console").option("--output-file <path>", "Output file path (for json/markdown)").action(async (directory, options) => {
   console.log(import_chalk.default.blue("\u{1F50D} Analyzing consistency...\n"));
@@ -1461,14 +1461,14 @@ function displayConsoleReport(report, elapsedTime) {
   const { summary, results, recommendations } = report;
   console.log(import_chalk.default.bold("\n\u{1F4CA} Summary\n"));
   console.log(`Files Analyzed: ${import_chalk.default.cyan(summary.filesAnalyzed)}`);
-  console.log(`Total Issues: ${import_chalk.default.yellow(summary.totalIssues)}`);
+  console.log(`Total Patterns Found: ${import_chalk.default.yellow(summary.totalIssues)}`);
   console.log(`  Naming: ${import_chalk.default.yellow(summary.namingIssues)}`);
-  console.log(`  Patterns: ${import_chalk.default.yellow(summary.patternIssues)}`);
+  console.log(`  Code Patterns: ${import_chalk.default.yellow(summary.patternIssues)}`);
   console.log(`  Architecture: ${import_chalk.default.yellow(summary.architectureIssues)}`);
   console.log(`Analysis Time: ${import_chalk.default.gray(elapsedTime + "s")}
 `);
   if (summary.totalIssues === 0) {
-    console.log(import_chalk.default.green("\u2728 No consistency issues found! Your codebase is well-maintained.\n"));
+    console.log(import_chalk.default.green("\u2728 No consistency patterns found! Your codebase is AI-friendly.\n"));
     return;
   }
   const namingResults = results.filter(
@@ -1478,11 +1478,11 @@ function displayConsoleReport(report, elapsedTime) {
     (r) => r.issues.some((i) => i.category === "patterns")
   );
   if (namingResults.length > 0) {
-    console.log(import_chalk.default.bold("\u{1F3F7}\uFE0F  Naming Issues\n"));
+    console.log(import_chalk.default.bold("\u{1F3F7}\uFE0F  Naming Patterns\n"));
     displayCategoryIssues(namingResults, 5);
   }
   if (patternResults.length > 0) {
-    console.log(import_chalk.default.bold("\n\u{1F504} Pattern Issues\n"));
+    console.log(import_chalk.default.bold("\n\u{1F504} Code Patterns\n"));
     displayCategoryIssues(patternResults, 5);
   }
   console.log(import_chalk.default.bold("\n\u{1F4A1} Recommendations\n"));
@@ -1513,7 +1513,7 @@ function displayCategoryIssues(results, maxToShow) {
   }
   const remaining = results.reduce((sum, r) => sum + r.issues.length, 0) - shown;
   if (remaining > 0) {
-    console.log(import_chalk.default.dim(`  ... and ${remaining} more issues
+    console.log(import_chalk.default.dim(`  ... and ${remaining} more patterns
 `));
   }
 }
@@ -1532,28 +1532,28 @@ function generateMarkdownReport(report, elapsedTime) {
 `;
   markdown += `- **Files Analyzed:** ${summary.filesAnalyzed}
 `;
-  markdown += `- **Total Issues:** ${summary.totalIssues}
+  markdown += `- **Total Patterns Found:** ${summary.totalIssues}
 `;
   markdown += `  - Naming: ${summary.namingIssues}
 `;
-  markdown += `  - Patterns: ${summary.patternIssues}
+  markdown += `  - Code Patterns: ${summary.patternIssues}
 `;
   markdown += `  - Architecture: ${summary.architectureIssues}
 
 `;
   if (summary.totalIssues === 0) {
-    markdown += `\u2728 No consistency issues found!
+    markdown += `\u2728 No consistency patterns found! Your codebase is AI-friendly.
 `;
     return markdown;
   }
-  markdown += `## Issues by Category
+  markdown += `## Patterns by Category
 
 `;
   const namingResults = results.filter(
     (r) => r.issues.some((i) => i.category === "naming")
   );
   if (namingResults.length > 0) {
-    markdown += `### \u{1F3F7}\uFE0F Naming Issues
+    markdown += `### \u{1F3F7}\uFE0F Naming Patterns
 
 `;
     for (const result of namingResults) {
@@ -1576,7 +1576,7 @@ function generateMarkdownReport(report, elapsedTime) {
     (r) => r.issues.some((i) => i.category === "patterns")
   );
   if (patternResults.length > 0) {
-    markdown += `### \u{1F504} Pattern Issues
+    markdown += `### \u{1F504} Code Patterns
 
 `;
     for (const result of patternResults) {

package/dist/cli.mjs

@@ -10,7 +10,7 @@ import { writeFileSync, mkdirSync, existsSync } from "fs";
 import { dirname } from "path";
 import { loadConfig, mergeConfigWithDefaults, resolveOutputPath } from "@aiready/core";
 var program = new Command();
-program.name("aiready-consistency").description("Detect consistency issues in naming, patterns, and architecture").version("0.1.0").addHelpText("after", `
+program.name("aiready-consistency").description("Detect consistency patterns in naming, code structure, and architecture").version("0.1.0").addHelpText("after", `
 CONFIGURATION:
   Supports config files: aiready.json, aiready.config.json, .aiready.json, .aireadyrc.json
   CLI options override config file settings
@@ -23,7 +23,7 @@ ANALYSIS CATEGORIES:
 EXAMPLES:
   aiready-consistency .                               # Full analysis
   aiready-consistency . --no-naming                   # Skip naming checks
-  aiready-consistency . --min-severity major          # Only show major+ issues
+  aiready-consistency . --min-severity major          # Only show major+ patterns
   aiready-consistency . --output json > report.json   # JSON export
 `).argument("<directory>", "Directory to analyze").option("--naming", "Check naming conventions and quality (default: true)").option("--no-naming", "Skip naming analysis").option("--patterns", "Check code pattern consistency (default: true)").option("--no-patterns", "Skip pattern analysis").option("--architecture", "Check architectural consistency (not yet implemented)").option("--min-severity <level>", "Minimum severity: info|minor|major|critical. Default: info").option("--include <patterns>", "File patterns to include (comma-separated)").option("--exclude <patterns>", "File patterns to exclude (comma-separated)").option("-o, --output <format>", "Output format: console|json|markdown", "console").option("--output-file <path>", "Output file path (for json/markdown)").action(async (directory, options) => {
   console.log(chalk.blue("\u{1F50D} Analyzing consistency...\n"));
@@ -84,14 +84,14 @@ function displayConsoleReport(report, elapsedTime) {
   const { summary, results, recommendations } = report;
   console.log(chalk.bold("\n\u{1F4CA} Summary\n"));
   console.log(`Files Analyzed: ${chalk.cyan(summary.filesAnalyzed)}`);
-  console.log(`Total Issues: ${chalk.yellow(summary.totalIssues)}`);
+  console.log(`Total Patterns Found: ${chalk.yellow(summary.totalIssues)}`);
   console.log(`  Naming: ${chalk.yellow(summary.namingIssues)}`);
-  console.log(`  Patterns: ${chalk.yellow(summary.patternIssues)}`);
+  console.log(`  Code Patterns: ${chalk.yellow(summary.patternIssues)}`);
   console.log(`  Architecture: ${chalk.yellow(summary.architectureIssues)}`);
   console.log(`Analysis Time: ${chalk.gray(elapsedTime + "s")}
 `);
   if (summary.totalIssues === 0) {
-    console.log(chalk.green("\u2728 No consistency issues found! Your codebase is well-maintained.\n"));
+    console.log(chalk.green("\u2728 No consistency patterns found! Your codebase is AI-friendly.\n"));
     return;
   }
   const namingResults = results.filter(
@@ -101,11 +101,11 @@ function displayConsoleReport(report, elapsedTime) {
     (r) => r.issues.some((i) => i.category === "patterns")
   );
   if (namingResults.length > 0) {
-    console.log(chalk.bold("\u{1F3F7}\uFE0F  Naming Issues\n"));
+    console.log(chalk.bold("\u{1F3F7}\uFE0F  Naming Patterns\n"));
     displayCategoryIssues(namingResults, 5);
   }
   if (patternResults.length > 0) {
-    console.log(chalk.bold("\n\u{1F504} Pattern Issues\n"));
+    console.log(chalk.bold("\n\u{1F504} Code Patterns\n"));
     displayCategoryIssues(patternResults, 5);
   }
   console.log(chalk.bold("\n\u{1F4A1} Recommendations\n"));
@@ -136,7 +136,7 @@ function displayCategoryIssues(results, maxToShow) {
   }
   const remaining = results.reduce((sum, r) => sum + r.issues.length, 0) - shown;
   if (remaining > 0) {
-    console.log(chalk.dim(`  ... and ${remaining} more issues
+    console.log(chalk.dim(`  ... and ${remaining} more patterns
 `));
   }
 }
@@ -155,28 +155,28 @@ function generateMarkdownReport(report, elapsedTime) {
 `;
   markdown += `- **Files Analyzed:** ${summary.filesAnalyzed}
 `;
-  markdown += `- **Total Issues:** ${summary.totalIssues}
+  markdown += `- **Total Patterns Found:** ${summary.totalIssues}
 `;
   markdown += `  - Naming: ${summary.namingIssues}
 `;
-  markdown += `  - Patterns: ${summary.patternIssues}
+  markdown += `  - Code Patterns: ${summary.patternIssues}
 `;
   markdown += `  - Architecture: ${summary.architectureIssues}
 
 `;
   if (summary.totalIssues === 0) {
-    markdown += `\u2728 No consistency issues found!
+    markdown += `\u2728 No consistency patterns found! Your codebase is AI-friendly.
 `;
     return markdown;
   }
-  markdown += `## Issues by Category
+  markdown += `## Patterns by Category
 
 `;
   const namingResults = results.filter(
     (r) => r.issues.some((i) => i.category === "naming")
   );
   if (namingResults.length > 0) {
-    markdown += `### \u{1F3F7}\uFE0F Naming Issues
+    markdown += `### \u{1F3F7}\uFE0F Naming Patterns
 
 `;
     for (const result of namingResults) {
@@ -199,7 +199,7 @@ function generateMarkdownReport(report, elapsedTime) {
     (r) => r.issues.some((i) => i.category === "patterns")
   );
   if (patternResults.length > 0) {
-    markdown += `### \u{1F504} Pattern Issues
+    markdown += `### \u{1F504} Code Patterns
 
 `;
     for (const result of patternResults) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/consistency",
-  "version": "0.6.8",
+  "version": "0.6.10",
   "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": "^12.1.0",
-    "@aiready/core": "0.7.5"
+    "@aiready/core": "0.7.7"
   },
   "devDependencies": {
     "@types/node": "^22.10.5",

package/src/cli.ts

@@ -12,7 +12,7 @@ const program = new Command();
 
 program
   .name('aiready-consistency')
-  .description('Detect consistency issues in naming, patterns, and architecture')
+  .description('Detect consistency patterns in naming, code structure, and architecture')
   .version('0.1.0')
   .addHelpText('after', `
 CONFIGURATION:
@@ -27,7 +27,7 @@ ANALYSIS CATEGORIES:
 EXAMPLES:
   aiready-consistency .                               # Full analysis
   aiready-consistency . --no-naming                   # Skip naming checks
-  aiready-consistency . --min-severity major          # Only show major+ issues
+  aiready-consistency . --min-severity major          # Only show major+ patterns
   aiready-consistency . --output json > report.json   # JSON export
 `)
   .argument('<directory>', 'Directory to analyze')
@@ -121,14 +121,14 @@ function displayConsoleReport(report: any, elapsedTime: string): void {
 
   console.log(chalk.bold('\n📊 Summary\n'));
   console.log(`Files Analyzed: ${chalk.cyan(summary.filesAnalyzed)}`);
-  console.log(`Total Issues: ${chalk.yellow(summary.totalIssues)}`);
+  console.log(`Total Patterns Found: ${chalk.yellow(summary.totalIssues)}`);
   console.log(`  Naming: ${chalk.yellow(summary.namingIssues)}`);
-  console.log(`  Patterns: ${chalk.yellow(summary.patternIssues)}`);
+  console.log(`  Code Patterns: ${chalk.yellow(summary.patternIssues)}`);
   console.log(`  Architecture: ${chalk.yellow(summary.architectureIssues)}`);
   console.log(`Analysis Time: ${chalk.gray(elapsedTime + 's')}\n`);
 
   if (summary.totalIssues === 0) {
-    console.log(chalk.green('✨ No consistency issues found! Your codebase is well-maintained.\n'));
+    console.log(chalk.green('✨ No consistency patterns found! Your codebase is AI-friendly.\n'));
     return;
   }
 
@@ -141,12 +141,12 @@ function displayConsoleReport(report: any, elapsedTime: string): void {
   );
 
   if (namingResults.length > 0) {
-    console.log(chalk.bold('🏷️  Naming Issues\n'));
+    console.log(chalk.bold('🏷️  Naming Patterns\n'));
     displayCategoryIssues(namingResults, 5);
   }
 
   if (patternResults.length > 0) {
-    console.log(chalk.bold('\n🔄 Pattern Issues\n'));
+    console.log(chalk.bold('\n🔄 Code Patterns\n'));
     displayCategoryIssues(patternResults, 5);
   }
 
@@ -191,7 +191,7 @@ function displayCategoryIssues(results: any[], maxToShow: number): void {
 
   const remaining = results.reduce((sum, r) => sum + r.issues.length, 0) - shown;
   if (remaining > 0) {
-    console.log(chalk.dim(`  ... and ${remaining} more issues\n`));
+    console.log(chalk.dim(`  ... and ${remaining} more patterns\n`));
   }
 }
 
@@ -204,24 +204,24 @@ function generateMarkdownReport(report: any, elapsedTime: string): string {
 
   markdown += `## Summary\n\n`;
   markdown += `- **Files Analyzed:** ${summary.filesAnalyzed}\n`;
-  markdown += `- **Total Issues:** ${summary.totalIssues}\n`;
+  markdown += `- **Total Patterns Found:** ${summary.totalIssues}\n`;
   markdown += `  - Naming: ${summary.namingIssues}\n`;
-  markdown += `  - Patterns: ${summary.patternIssues}\n`;
+  markdown += `  - Code Patterns: ${summary.patternIssues}\n`;
   markdown += `  - Architecture: ${summary.architectureIssues}\n\n`;
 
   if (summary.totalIssues === 0) {
-    markdown += `✨ No consistency issues found!\n`;
+    markdown += `✨ No consistency patterns found! Your codebase is AI-friendly.\n`;
     return markdown;
   }
 
-  markdown += `## Issues by Category\n\n`;
+  markdown += `## Patterns by Category\n\n`;
 
-  // Naming issues
+  // Naming patterns
   const namingResults = results.filter((r: any) =>
     r.issues.some((i: any) => i.category === 'naming')
   );
   if (namingResults.length > 0) {
-    markdown += `### 🏷️ Naming Issues\n\n`;
+    markdown += `### 🏷️ Naming Patterns\n\n`;
     for (const result of namingResults) {
       for (const issue of result.issues) {
         if (issue.category !== 'naming') continue;
@@ -235,12 +235,12 @@ function generateMarkdownReport(report: any, elapsedTime: string): string {
     markdown += `\n`;
   }
 
-  // Pattern issues
+  // Code patterns
   const patternResults = results.filter((r: any) =>
     r.issues.some((i: any) => i.category === 'patterns')
   );
   if (patternResults.length > 0) {
-    markdown += `### 🔄 Pattern Issues\n\n`;
+    markdown += `### 🔄 Code Patterns\n\n`;
     for (const result of patternResults) {
       for (const issue of result.issues) {
         if (issue.category !== 'patterns') continue;