@aiready/consistency 0.20.5 → 0.20.6

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/consistency@0.20.5 build /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.20.6 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
-CJS dist/index.js 30.95 KB
-CJS dist/cli.js   33.06 KB
-CJS ⚡️ Build success in 51ms
 ESM dist/cli.mjs            8.83 KB
 ESM dist/index.mjs          7.04 KB
 ESM dist/chunk-S6BZVTWN.mjs 22.19 KB
-ESM ⚡️ Build success in 82ms
+ESM ⚡️ Build success in 120ms
+CJS dist/cli.js   33.06 KB
+CJS dist/index.js 30.95 KB
+CJS ⚡️ Build success in 120ms
 DTS Build start
-DTS ⚡️ Build success in 6676ms
+DTS ⚡️ Build success in 2903ms
 DTS dist/cli.d.ts    20.00 B
-DTS dist/index.d.ts  3.65 KB
+DTS dist/index.d.ts  3.87 KB
 DTS dist/cli.d.mts   20.00 B
-DTS dist/index.d.mts 3.65 KB
+DTS dist/index.d.mts 3.87 KB

package/.turbo/turbo-test.log

@@ -1,27 +1,31 @@
 
 
-> @aiready/consistency@0.20.3 test /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.20.5 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
+ ✓ dist/__tests__/scoring.test.js (8 tests) 19ms
+ ✓ src/__tests__/provider.test.ts (2 tests) 3ms
+ ✓ src/__tests__/scoring.test.ts (8 tests) 33ms
+ ✓ src/__tests__/language-filter.test.ts (3 tests) 34ms
+Sourcemap for "/Users/pengcao/projects/aiready/packages/consistency/dist/analyzers/naming-python.js" points to missing source files
 stderr | src/__tests__/contract.test.ts > Consistency Spoke Contract Validation > should produce output matching the SpokeOutput contract
 Consistency: Failed to analyze file1.ts: Error: ENOENT: no such file or directory, open 'file1.ts'
 
- ✓ src/__tests__/contract.test.ts (1 test) 6ms
- ✓ src/__tests__/language-filter.test.ts (3 tests) 7ms
- ✓ src/__tests__/provider.test.ts (2 tests) 7ms
-Sourcemap for "/Users/pengcao/projects/aiready/packages/consistency/dist/analyzers/naming-python.js" points to missing source files
- ✓ src/__tests__/scoring.test.ts (8 tests) 5ms
- ✓ dist/__tests__/language-filter.test.js (3 tests) 4ms
- ✓ dist/__tests__/analyzer.test.js (18 tests) 190ms
- ✓ src/__tests__/analyzer.test.ts (18 tests) 236ms
+ ✓ src/__tests__/contract.test.ts (1 test) 8ms
+ ✓ dist/__tests__/language-filter.test.js (3 tests) 8ms
+ ✓ src/__tests__/analyzer.test.ts (18 tests) 1247ms
+     ✓ should analyze naming issues  713ms
+     ✓ should generate relevant recommendations  409ms
+ ✓ dist/__tests__/analyzer.test.js (18 tests) 1196ms
+     ✓ should analyze naming issues  611ms
+     ✓ should detect minimum severity filtering  314ms
 
  Test Files  8 passed (8)
       Tests  61 passed (61)
-   Start at  10:36:28
-   Duration  1.30s (transform 1.29s, setup 0ms, import 4.87s, tests 458ms, environment 1ms)
+   Start at  10:12:34
+   Duration  6.71s (transform 7.21s, setup 0ms, import 27.92s, tests 2.55s, environment 1ms)
 
 [?25h

package/dist/index.d.mts

@@ -61,8 +61,12 @@ interface ConsistencyReport {
 }
 
 /**
- * Main consistency analyzer that orchestrates all analysis types
- * Supports: TypeScript, JavaScript, Python, Java, C#, Go
+ * Main consistency analyzer that orchestrates all analysis types.
+ * Supports: TypeScript, JavaScript, Python, Java, C#, Go.
+ *
+ * @param options - Configuration for consistency analysis and file scanning.
+ * @returns Promise resolving to the comprehensive consistency report.
+ * @lastUpdated 2026-03-18
  */
 declare function analyzeConsistency(options: ConsistencyOptions): Promise<ConsistencyReport>;
 
@@ -96,15 +100,13 @@ declare function detectNamingConventions(files: string[], allIssues: Array<{
 declare function analyzePatterns(filePaths: string[]): Promise<PatternIssue[]>;
 
 /**
- * Calculate AI Readiness Score for code consistency (0-100)
- *
- * Based on:
- * - Issue density (issues per file)
- * - Weighted severity (critical: 10pts, major: 3pts, minor: 0.5pts)
- * - Pattern consistency across codebase
+ * Calculate AI Readiness Score for code consistency (0-100).
  *
- * Includes business value metrics:
- * - Estimated developer hours to fix consistency issues
+ * @param issues - Array of detected consistency issues.
+ * @param totalFilesAnalyzed - Total number of files scanned.
+ * @param costConfig - Optional configuration for productivity cost calculation.
+ * @returns Standardized scoring output for the consistency tool.
+ * @lastUpdated 2026-03-18
  */
 declare function calculateConsistencyScore(issues: ConsistencyIssue[], totalFilesAnalyzed: number, costConfig?: Partial<CostConfig>): ToolScoringOutput;
 

package/dist/index.d.ts

@@ -61,8 +61,12 @@ interface ConsistencyReport {
 }
 
 /**
- * Main consistency analyzer that orchestrates all analysis types
- * Supports: TypeScript, JavaScript, Python, Java, C#, Go
+ * Main consistency analyzer that orchestrates all analysis types.
+ * Supports: TypeScript, JavaScript, Python, Java, C#, Go.
+ *
+ * @param options - Configuration for consistency analysis and file scanning.
+ * @returns Promise resolving to the comprehensive consistency report.
+ * @lastUpdated 2026-03-18
  */
 declare function analyzeConsistency(options: ConsistencyOptions): Promise<ConsistencyReport>;
 
@@ -96,15 +100,13 @@ declare function detectNamingConventions(files: string[], allIssues: Array<{
 declare function analyzePatterns(filePaths: string[]): Promise<PatternIssue[]>;
 
 /**
- * Calculate AI Readiness Score for code consistency (0-100)
- *
- * Based on:
- * - Issue density (issues per file)
- * - Weighted severity (critical: 10pts, major: 3pts, minor: 0.5pts)
- * - Pattern consistency across codebase
+ * Calculate AI Readiness Score for code consistency (0-100).
  *
- * Includes business value metrics:
- * - Estimated developer hours to fix consistency issues
+ * @param issues - Array of detected consistency issues.
+ * @param totalFilesAnalyzed - Total number of files scanned.
+ * @param costConfig - Optional configuration for productivity cost calculation.
+ * @returns Standardized scoring output for the consistency tool.
+ * @lastUpdated 2026-03-18
  */
 declare function calculateConsistencyScore(issues: ConsistencyIssue[], totalFilesAnalyzed: number, costConfig?: Partial<CostConfig>): ToolScoringOutput;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/consistency",
-  "version": "0.20.5",
+  "version": "0.20.6",
   "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.23.6"
+    "@aiready/core": "0.23.7"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",

package/src/analyzer.ts

@@ -15,8 +15,12 @@ import { analyzeNamingGeneralized } from './analyzers/naming-generalized';
 import { analyzePatterns } from './analyzers/patterns';
 
 /**
- * Main consistency analyzer that orchestrates all analysis types
- * Supports: TypeScript, JavaScript, Python, Java, C#, Go
+ * Main consistency analyzer that orchestrates all analysis types.
+ * Supports: TypeScript, JavaScript, Python, Java, C#, Go.
+ *
+ * @param options - Configuration for consistency analysis and file scanning.
+ * @returns Promise resolving to the comprehensive consistency report.
+ * @lastUpdated 2026-03-18
  */
 export async function analyzeConsistency(
   options: ConsistencyOptions
@@ -126,6 +130,13 @@ export async function analyzeConsistency(
   } as unknown as ConsistencyReport;
 }
 
+/**
+ * Check if an issue severity meets the minimum threshold.
+ *
+ * @param severity - The severity of the issue.
+ * @param minSeverity - The minimum severity threshold.
+ * @returns True if severity is greater than or equal to minSeverity.
+ */
 function shouldIncludeSeverity(
   severity: Severity | string,
   minSeverity: Severity | string
@@ -134,7 +145,10 @@ function shouldIncludeSeverity(
 }
 
 /**
- * Map string type to IssueType enum value
+ * Map string type to IssueType enum value.
+ *
+ * @param type - The raw issue type string.
+ * @returns Normalized IssueType enum.
  */
 function getIssueType(type: string | undefined): IssueType {
   if (!type) return IssueType.NamingInconsistency;
@@ -155,7 +169,10 @@ function getIssueType(type: string | undefined): IssueType {
 }
 
 /**
- * Transform NamingIssue or PatternIssue to the required Issue format
+ * Transform NamingIssue or PatternIssue to the required Issue format.
+ *
+ * @param i - The raw issue object to transform.
+ * @returns Standardized Issue object.
  */
 function transformToIssue(i: any): Issue {
   // If already has message and location, return as is

package/src/scoring.ts

@@ -3,15 +3,13 @@ import type { ToolScoringOutput, CostConfig } from '@aiready/core';
 import type { ConsistencyIssue } from './types';
 
 /**
- * Calculate AI Readiness Score for code consistency (0-100)
+ * Calculate AI Readiness Score for code consistency (0-100).
  *
- * Based on:
- * - Issue density (issues per file)
- * - Weighted severity (critical: 10pts, major: 3pts, minor: 0.5pts)
- * - Pattern consistency across codebase
- *
- * Includes business value metrics:
- * - Estimated developer hours to fix consistency issues
+ * @param issues - Array of detected consistency issues.
+ * @param totalFilesAnalyzed - Total number of files scanned.
+ * @param costConfig - Optional configuration for productivity cost calculation.
+ * @returns Standardized scoring output for the consistency tool.
+ * @lastUpdated 2026-03-18
  */
 export function calculateConsistencyScore(
   issues: ConsistencyIssue[],