@aiready/consistency 0.8.31 → 0.8.34

package/src/cli.ts

@@ -5,16 +5,24 @@ import { analyzeConsistency } from './analyzer';
 import type { ConsistencyOptions } from './types';
 import chalk from 'chalk';
 import { writeFileSync, mkdirSync, existsSync } from 'fs';
-import { join, dirname } from 'path';
-import { loadConfig, mergeConfigWithDefaults, resolveOutputPath } from '@aiready/core';
+import { dirname } from 'path';
+import {
+  loadConfig,
+  mergeConfigWithDefaults,
+  resolveOutputPath,
+} from '@aiready/core';
 
 const program = new Command();
 
 program
   .name('aiready-consistency')
-  .description('Detect consistency patterns in naming, code structure, and architecture')
+  .description(
+    'Detect consistency patterns in naming, code structure, and architecture'
+  )
   .version('0.1.0')
-  .addHelpText('after', `
+  .addHelpText(
+    'after',
+    `
 LANGUAGE SUPPORT:
   Supported: TypeScript (.ts, .tsx), JavaScript (.js, .jsx)
   Note: Python, Java, and other language files will be safely ignored
@@ -33,17 +41,28 @@ EXAMPLES:
   aiready-consistency . --no-naming                   # Skip naming checks
   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(
+    '--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(
+    '-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('🔍 Analyzing consistency...\n'));
@@ -89,12 +108,12 @@ EXAMPLES:
         `consistency-report-${new Date().toISOString().split('T')[0]}.json`,
         directory
       );
-      
+
       const dir = dirname(outputPath);
       if (!existsSync(dir)) {
         mkdirSync(dir, { recursive: true });
       }
-      
+
       writeFileSync(outputPath, output);
       console.log(chalk.green(`✓ Report saved to ${outputPath}`));
     } else if (options.output === 'markdown') {
@@ -104,12 +123,12 @@ EXAMPLES:
         `consistency-report-${new Date().toISOString().split('T')[0]}.md`,
         directory
       );
-      
+
       const dir = dirname(outputPath);
       if (!existsSync(dir)) {
         mkdirSync(dir, { recursive: true });
       }
-      
+
       writeFileSync(outputPath, markdown);
       console.log(chalk.green(`✓ Report saved to ${outputPath}`));
     } else {
@@ -132,7 +151,11 @@ function displayConsoleReport(report: any, elapsedTime: string): void {
   console.log(`Analysis Time: ${chalk.gray(elapsedTime + 's')}\n`);
 
   if (summary.totalIssues === 0) {
-    console.log(chalk.green('✨ No consistency patterns found! Your codebase is AI-friendly.\n'));
+    console.log(
+      chalk.green(
+        '✨ No consistency patterns found! Your codebase is AI-friendly.\n'
+      )
+    );
     return;
   }
 
@@ -174,10 +197,10 @@ function displayCategoryIssues(results: any[], maxToShow: number): void {
         issue.severity === 'critical'
           ? chalk.red
           : issue.severity === 'major'
-          ? chalk.yellow
-          : issue.severity === 'minor'
-          ? chalk.blue
-          : chalk.gray;
+            ? chalk.yellow
+            : issue.severity === 'minor'
+              ? chalk.blue
+              : chalk.gray;
 
       console.log(
         `${severityColor(issue.severity.toUpperCase())} ${chalk.dim(
@@ -193,7 +216,8 @@ function displayCategoryIssues(results: any[], maxToShow: number): void {
     }
   }
 
-  const remaining = results.reduce((sum, r) => sum + r.issues.length, 0) - shown;
+  const remaining =
+    results.reduce((sum, r) => sum + r.issues.length, 0) - shown;
   if (remaining > 0) {
     console.log(chalk.dim(`  ... and ${remaining} more patterns\n`));
   }

package/src/scoring.ts

@@ -1,19 +1,15 @@
-import { 
-  calculateProductivityImpact,
-  DEFAULT_COST_CONFIG,
-  type CostConfig 
-} from '@aiready/core';
-import type { ToolScoringOutput } from '@aiready/core';
+import { calculateProductivityImpact } from '@aiready/core';
+import type { ToolScoringOutput, CostConfig } from '@aiready/core';
 import type { ConsistencyIssue } from './types';
 
 /**
  * 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
  */
@@ -22,31 +18,36 @@ export function calculateConsistencyScore(
   totalFilesAnalyzed: number,
   costConfig?: Partial<CostConfig>
 ): ToolScoringOutput {
-  const criticalIssues = issues.filter(i => i.severity === 'critical').length;
-  const majorIssues = issues.filter(i => i.severity === 'major').length;
-  const minorIssues = issues.filter(i => i.severity === 'minor').length;
+  // Parameter reserved for future configuration; reference to avoid lint warnings
+  void costConfig;
+  const criticalIssues = issues.filter((i) => i.severity === 'critical').length;
+  const majorIssues = issues.filter((i) => i.severity === 'major').length;
+  const minorIssues = issues.filter((i) => i.severity === 'minor').length;
   const totalIssues = issues.length;
-  
+
   // Issue density penalty (0-50 points)
   // Ideal: 0 issues/file = 0 penalty
   // Acceptable: <1 issue/file = 10 penalty
   // High: 1-3 issues/file = 10-40 penalty
   // Critical: >3 issues/file = 40-50 penalty
-  const issuesPerFile = totalFilesAnalyzed > 0 ? totalIssues / totalFilesAnalyzed : 0;
+  const issuesPerFile =
+    totalFilesAnalyzed > 0 ? totalIssues / totalFilesAnalyzed : 0;
   const densityPenalty = Math.min(50, issuesPerFile * 15);
-  
+
   // Weighted severity penalty (0-50 points)
   // Each critical: 10 points
   // Each major: 3 points
   // Each minor: 0.5 points
-  const weightedCount = (criticalIssues * 10) + (majorIssues * 3) + (minorIssues * 0.5);
-  const avgWeightedIssuesPerFile = totalFilesAnalyzed > 0 ? weightedCount / totalFilesAnalyzed : 0;
+  const weightedCount =
+    criticalIssues * 10 + majorIssues * 3 + minorIssues * 0.5;
+  const avgWeightedIssuesPerFile =
+    totalFilesAnalyzed > 0 ? weightedCount / totalFilesAnalyzed : 0;
   const severityPenalty = Math.min(50, avgWeightedIssuesPerFile * 2);
-  
+
   // Calculate final score
   const rawScore = 100 - densityPenalty - severityPenalty;
   const score = Math.max(0, Math.min(100, Math.round(rawScore)));
-  
+
   // Build factors array
   const factors: ToolScoringOutput['factors'] = [
     {
@@ -55,7 +56,7 @@ export function calculateConsistencyScore(
       description: `${issuesPerFile.toFixed(2)} issues per file ${issuesPerFile < 1 ? '(excellent)' : issuesPerFile < 3 ? '(acceptable)' : '(high)'}`,
     },
   ];
-  
+
   if (criticalIssues > 0) {
     const criticalImpact = Math.min(30, criticalIssues * 10);
     factors.push({
@@ -64,7 +65,7 @@ export function calculateConsistencyScore(
       description: `${criticalIssues} critical consistency issue${criticalIssues > 1 ? 's' : ''} (high AI confusion risk)`,
     });
   }
-  
+
   if (majorIssues > 0) {
     const majorImpact = Math.min(20, Math.round(majorIssues * 3));
     factors.push({
@@ -73,7 +74,7 @@ export function calculateConsistencyScore(
       description: `${majorIssues} major issue${majorIssues > 1 ? 's' : ''} (moderate AI confusion risk)`,
     });
   }
-  
+
   if (minorIssues > 0 && minorIssues >= totalFilesAnalyzed) {
     const minorImpact = -Math.round(minorIssues * 0.5);
     factors.push({
@@ -82,19 +83,20 @@ export function calculateConsistencyScore(
       description: `${minorIssues} minor issue${minorIssues > 1 ? 's' : ''} (slight AI confusion risk)`,
     });
   }
-  
+
   // Generate recommendations
   const recommendations: ToolScoringOutput['recommendations'] = [];
-  
+
   if (criticalIssues > 0) {
     const estimatedImpact = Math.min(30, criticalIssues * 10);
     recommendations.push({
-      action: 'Fix critical naming/pattern inconsistencies (highest AI confusion risk)',
+      action:
+        'Fix critical naming/pattern inconsistencies (highest AI confusion risk)',
       estimatedImpact,
       priority: 'high',
     });
   }
-  
+
   if (majorIssues > 5) {
     const estimatedImpact = Math.min(15, Math.round(majorIssues / 2));
     recommendations.push({
@@ -103,15 +105,16 @@ export function calculateConsistencyScore(
       priority: 'medium',
     });
   }
-  
+
   if (issuesPerFile > 3) {
     recommendations.push({
-      action: 'Establish and enforce coding style guide to reduce inconsistencies',
+      action:
+        'Establish and enforce coding style guide to reduce inconsistencies',
       estimatedImpact: 12,
       priority: 'medium',
     });
   }
-  
+
   if (totalIssues > 20 && minorIssues / totalIssues > 0.7) {
     recommendations.push({
       action: 'Enable linter/formatter to automatically fix minor style issues',
@@ -119,10 +122,10 @@ export function calculateConsistencyScore(
       priority: 'low',
     });
   }
-  
+
   // Calculate business value metrics
   const productivityImpact = calculateProductivityImpact(issues);
-  
+
   return {
     toolName: 'consistency',
     score,
@@ -132,7 +135,8 @@ export function calculateConsistencyScore(
       majorIssues,
       minorIssues,
       issuesPerFile: Math.round(issuesPerFile * 100) / 100,
-      avgWeightedIssuesPerFile: Math.round(avgWeightedIssuesPerFile * 100) / 100,
+      avgWeightedIssuesPerFile:
+        Math.round(avgWeightedIssuesPerFile * 100) / 100,
       // Business value metrics
       estimatedDeveloperHours: productivityImpact.totalHours,
     },

package/src/types.ts

@@ -12,7 +12,7 @@ export interface ConsistencyOptions extends ScanOptions {
 }
 
 export interface ConsistencyIssue extends Issue {
-  type: 
+  type:
     | 'naming-inconsistency'
     | 'naming-quality'
     | 'pattern-inconsistency'
@@ -32,6 +32,7 @@ export interface NamingIssue {
   identifier: string;
   suggestion?: string;
   severity: 'critical' | 'major' | 'minor' | 'info';
+  category?: 'naming';
 }
 
 export interface PatternIssue {

package/src/utils/ast-parser.ts

@@ -5,11 +5,14 @@ import { readFileSync } from 'fs';
  * Parse a file into an AST
  * Only supports TypeScript/JavaScript files (.ts, .tsx, .js, .jsx)
  */
-export function parseFile(filePath: string, content?: string): TSESTree.Program | null {
+export function parseFile(
+  filePath: string,
+  content?: string
+): TSESTree.Program | null {
   try {
     const code = content ?? readFileSync(filePath, 'utf-8');
     const isTypeScript = filePath.match(/\.tsx?$/);
-    
+
     return parse(code, {
       jsx: filePath.match(/\.[jt]sx$/i) !== null,
       loc: true,
@@ -23,6 +26,7 @@ export function parseFile(filePath: string, content?: string): TSESTree.Program
       filePath: isTypeScript ? filePath : undefined,
     });
   } catch (error) {
+    void error;
     // Silently skip files that fail to parse (likely non-JS/TS or syntax errors)
     // Non-JS/TS files should be filtered before reaching this point
     return null;
@@ -47,7 +51,7 @@ export function traverseAST(
   // Visit children
   for (const key of Object.keys(node)) {
     const value = (node as any)[key];
-    
+
     if (Array.isArray(value)) {
       for (const child of value) {
         if (child && typeof child === 'object' && 'type' in child) {
@@ -70,7 +74,7 @@ export function hasAncestor(
   ancestorTypes: string[],
   ancestors: TSESTree.Node[]
 ): boolean {
-  return ancestors.some(ancestor => ancestorTypes.includes(ancestor.type));
+  return ancestors.some((ancestor) => ancestorTypes.includes(ancestor.type));
 }
 
 /**
@@ -135,7 +139,7 @@ export function getFunctionName(node: TSESTree.Node): string | null {
  */
 export function isInDestructuring(node: TSESTree.Node): boolean {
   if (!node) return false;
-  
+
   return node.type === 'ObjectPattern' || node.type === 'ArrayPattern';
 }
 
@@ -149,34 +153,48 @@ export function getLineNumber(node: TSESTree.Node): number {
 /**
  * Check if a node represents a coverage metric context
  */
-export function isCoverageContext(node: TSESTree.Node, ancestors: TSESTree.Node[]): boolean {
+export function isCoverageContext(
+  node: TSESTree.Node,
+  ancestors: TSESTree.Node[]
+): boolean {
   // Check if any ancestor or the node itself references coverage-related properties
-  const coveragePatterns = /coverage|summary|metrics|pct|percent|statements|branches|functions|lines/i;
-  
+  const coveragePatterns =
+    /coverage|summary|metrics|pct|percent|statements|branches|functions|lines/i;
+
   // Check variable name
   if (node.type === 'Identifier' && coveragePatterns.test(node.name)) {
     return true;
   }
-  
+
   // Check if it's a property of something coverage-related
-  for (const ancestor of ancestors.slice(-3)) { // Check last 3 ancestors
+  for (const ancestor of ancestors.slice(-3)) {
+    // Check last 3 ancestors
     if (ancestor.type === 'MemberExpression') {
       const memberExpr = ancestor as TSESTree.MemberExpression;
-      if (memberExpr.object.type === 'Identifier' && coveragePatterns.test(memberExpr.object.name)) {
+      if (
+        memberExpr.object.type === 'Identifier' &&
+        coveragePatterns.test(memberExpr.object.name)
+      ) {
         return true;
       }
     }
-    if (ancestor.type === 'ObjectPattern' || ancestor.type === 'ObjectExpression') {
+    if (
+      ancestor.type === 'ObjectPattern' ||
+      ancestor.type === 'ObjectExpression'
+    ) {
       // Check if parent variable has coverage-related name
       const parent = ancestors[ancestors.indexOf(ancestor) - 1];
       if (parent?.type === 'VariableDeclarator') {
         const varDecl = parent as TSESTree.VariableDeclarator;
-        if (varDecl.id.type === 'Identifier' && coveragePatterns.test(varDecl.id.name)) {
+        if (
+          varDecl.id.type === 'Identifier' &&
+          coveragePatterns.test(varDecl.id.name)
+        ) {
           return true;
         }
       }
     }
   }
-  
+
   return false;
 }

package/src/utils/config-loader.ts

@@ -19,7 +19,7 @@ export interface NamingConfig {
 /**
  * Loads and merges naming configuration for consistency analyzers
  * Extracts common config loading logic used by both naming.ts and naming-ast.ts
- * 
+ *
  * @param files - Array of files being analyzed (used to determine project root)
  * @returns Merged configuration with custom and default abbreviations/short words
  */
@@ -30,12 +30,17 @@ export async function loadNamingConfig(files: string[]): Promise<NamingConfig> {
   const consistencyConfig = config?.tools?.['consistency'];
 
   // Extract custom configuration
-  const customAbbreviations = new Set(consistencyConfig?.acceptedAbbreviations || []);
+  const customAbbreviations = new Set(
+    consistencyConfig?.acceptedAbbreviations || []
+  );
   const customShortWords = new Set(consistencyConfig?.shortWords || []);
   const disabledChecks = new Set(consistencyConfig?.disableChecks || []);
 
   // Merge with defaults
-  const allAbbreviations = new Set([...ACCEPTABLE_ABBREVIATIONS, ...customAbbreviations]);
+  const allAbbreviations = new Set([
+    ...ACCEPTABLE_ABBREVIATIONS,
+    ...customAbbreviations,
+  ]);
   const allShortWords = new Set([...COMMON_SHORT_WORDS, ...customShortWords]);
 
   return {