@aiready/pattern-detect 0.16.4 → 0.16.6

package/dist/index.d.mts

@@ -37,6 +37,10 @@ interface DetectionOptions {
 
 /**
  * Detect duplicate patterns across files
+ *
+ * @param fileContents - Array of file contents to analyze.
+ * @param options - Configuration for duplicate detection (thresholds, progress, etc).
+ * @returns Promise resolving to an array of detected duplicate patterns sorted by similarity.
  */
 declare function detectDuplicatePatterns(fileContents: FileContent[], options: DetectionOptions): Promise<DuplicatePattern[]>;
 
@@ -122,9 +126,20 @@ interface PatternSummary {
     }>;
 }
 /**
- * Determine smart defaults based on repository size estimation
+ * Determine smart defaults based on repository size estimation.
+ *
+ * @param directory - The directory to analyze for size.
+ * @param userOptions - User-provided option overrides.
+ * @returns Promise resolving to optimal detection options.
  */
 declare function getSmartDefaults(directory: string, userOptions: Partial<PatternDetectOptions>): Promise<PatternDetectOptions>;
+/**
+ * Main entry point for pattern detection analysis.
+ *
+ * @param options - Configuration including rootDir and detection parameters.
+ * @returns Promise resolving to the comprehensive pattern detect report.
+ * @lastUpdated 2026-03-18
+ */
 declare function analyzePatterns(options: PatternDetectOptions): Promise<{
     results: AnalysisResult[];
     duplicates: DuplicatePattern[];
@@ -133,6 +148,12 @@ declare function analyzePatterns(options: PatternDetectOptions): Promise<{
     clusters?: RefactorCluster[];
     config: PatternDetectOptions;
 }>;
+/**
+ * Generate a summary of pattern detection results.
+ *
+ * @param results - Array of file-level analysis results.
+ * @returns Consolidated pattern summary object.
+ */
 declare function generateSummary(results: AnalysisResult[]): PatternSummary;
 
 /**
@@ -146,6 +167,11 @@ declare function generateSummary(results: AnalysisResult[]): PatternSummary;
  * Includes business value metrics:
  * - Estimated monthly cost of token waste
  * - Estimated developer hours to fix
+ *
+ * @param duplicates - Array of detected duplicate patterns.
+ * @param totalFilesAnalyzed - Total count of files scanned.
+ * @param costConfig - Optional configuration for business value calculations.
+ * @returns Standardized scoring output for pattern detection.
  */
 declare function calculatePatternScore(duplicates: DuplicatePattern[], totalFilesAnalyzed: number, costConfig?: Partial<CostConfig>): ToolScoringOutput;
 
@@ -167,6 +193,13 @@ interface ContextRule {
 declare const CONTEXT_RULES: ContextRule[];
 /**
  * Calculate severity based on context rules and code characteristics
+ *
+ * @param file1 - First file path in the duplicate pair.
+ * @param file2 - Second file path in the duplicate pair.
+ * @param code - Snippet of the duplicated code.
+ * @param similarity - The calculated similarity score (0-1).
+ * @param linesOfCode - Number of lines in the duplicated block.
+ * @returns An object containing the severity level and reasoning.
  */
 declare function calculateSeverity(file1: string, file2: string, code: string, similarity: number, linesOfCode: number): {
     severity: Severity;
@@ -176,16 +209,26 @@ declare function calculateSeverity(file1: string, file2: string, code: string, s
 };
 /**
  * Get a human-readable severity label with emoji
+ *
+ * @param severity - The severity level to label.
+ * @returns Formatted label string for UI display.
  */
 declare function getSeverityLabel(severity: Severity): string;
 /**
  * Filter duplicates by minimum severity threshold
+ *
+ * @param duplicates - List of items with a severity property.
+ * @param minSeverity - Minimum threshold for inclusion.
+ * @returns Filtered list of items.
  */
 declare function filterBySeverity<T extends {
     severity: Severity;
 }>(duplicates: T[], minSeverity: Severity): T[];
 /**
- * Get severity threshold for filtering
+ * Get numerical similarity threshold associated with a severity level
+ *
+ * @param severity - The severity level to look up.
+ * @returns Minimum similarity value for this severity.
  */
 declare function getSeverityThreshold(severity: Severity): number;
 

package/dist/index.d.ts

@@ -37,6 +37,10 @@ interface DetectionOptions {
 
 /**
  * Detect duplicate patterns across files
+ *
+ * @param fileContents - Array of file contents to analyze.
+ * @param options - Configuration for duplicate detection (thresholds, progress, etc).
+ * @returns Promise resolving to an array of detected duplicate patterns sorted by similarity.
  */
 declare function detectDuplicatePatterns(fileContents: FileContent[], options: DetectionOptions): Promise<DuplicatePattern[]>;
 
@@ -122,9 +126,20 @@ interface PatternSummary {
     }>;
 }
 /**
- * Determine smart defaults based on repository size estimation
+ * Determine smart defaults based on repository size estimation.
+ *
+ * @param directory - The directory to analyze for size.
+ * @param userOptions - User-provided option overrides.
+ * @returns Promise resolving to optimal detection options.
  */
 declare function getSmartDefaults(directory: string, userOptions: Partial<PatternDetectOptions>): Promise<PatternDetectOptions>;
+/**
+ * Main entry point for pattern detection analysis.
+ *
+ * @param options - Configuration including rootDir and detection parameters.
+ * @returns Promise resolving to the comprehensive pattern detect report.
+ * @lastUpdated 2026-03-18
+ */
 declare function analyzePatterns(options: PatternDetectOptions): Promise<{
     results: AnalysisResult[];
     duplicates: DuplicatePattern[];
@@ -133,6 +148,12 @@ declare function analyzePatterns(options: PatternDetectOptions): Promise<{
     clusters?: RefactorCluster[];
     config: PatternDetectOptions;
 }>;
+/**
+ * Generate a summary of pattern detection results.
+ *
+ * @param results - Array of file-level analysis results.
+ * @returns Consolidated pattern summary object.
+ */
 declare function generateSummary(results: AnalysisResult[]): PatternSummary;
 
 /**
@@ -146,6 +167,11 @@ declare function generateSummary(results: AnalysisResult[]): PatternSummary;
  * Includes business value metrics:
  * - Estimated monthly cost of token waste
  * - Estimated developer hours to fix
+ *
+ * @param duplicates - Array of detected duplicate patterns.
+ * @param totalFilesAnalyzed - Total count of files scanned.
+ * @param costConfig - Optional configuration for business value calculations.
+ * @returns Standardized scoring output for pattern detection.
  */
 declare function calculatePatternScore(duplicates: DuplicatePattern[], totalFilesAnalyzed: number, costConfig?: Partial<CostConfig>): ToolScoringOutput;
 
@@ -167,6 +193,13 @@ interface ContextRule {
 declare const CONTEXT_RULES: ContextRule[];
 /**
  * Calculate severity based on context rules and code characteristics
+ *
+ * @param file1 - First file path in the duplicate pair.
+ * @param file2 - Second file path in the duplicate pair.
+ * @param code - Snippet of the duplicated code.
+ * @param similarity - The calculated similarity score (0-1).
+ * @param linesOfCode - Number of lines in the duplicated block.
+ * @returns An object containing the severity level and reasoning.
  */
 declare function calculateSeverity(file1: string, file2: string, code: string, similarity: number, linesOfCode: number): {
     severity: Severity;
@@ -176,16 +209,26 @@ declare function calculateSeverity(file1: string, file2: string, code: string, s
 };
 /**
  * Get a human-readable severity label with emoji
+ *
+ * @param severity - The severity level to label.
+ * @returns Formatted label string for UI display.
  */
 declare function getSeverityLabel(severity: Severity): string;
 /**
  * Filter duplicates by minimum severity threshold
+ *
+ * @param duplicates - List of items with a severity property.
+ * @param minSeverity - Minimum threshold for inclusion.
+ * @returns Filtered list of items.
  */
 declare function filterBySeverity<T extends {
     severity: Severity;
 }>(duplicates: T[], minSeverity: Severity): T[];
 /**
- * Get severity threshold for filtering
+ * Get numerical similarity threshold associated with a severity level
+ *
+ * @param severity - The severity level to look up.
+ * @returns Minimum similarity value for this severity.
  */
 declare function getSeverityThreshold(severity: Severity): number;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/pattern-detect",
-  "version": "0.16.4",
+  "version": "0.16.6",
   "description": "Semantic duplicate pattern detection for AI-generated code - finds similar implementations that waste AI context tokens",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -45,7 +45,7 @@
   "dependencies": {
     "commander": "^14.0.0",
     "chalk": "^5.3.0",
-    "@aiready/core": "0.23.4"
+    "@aiready/core": "0.23.7"
   },
   "devDependencies": {
     "tsup": "^8.3.5",