driftdetect 0.9.34 → 0.9.35

package/dist/services/scanner-service.d.ts

@@ -0,0 +1,237 @@
+/**
+ * Scanner Service - Enterprise-grade pattern detection with Worker Threads
+ *
+ * Uses the real detectors from driftdetect-detectors to find
+ * high-value architectural patterns and violations.
+ *
+ * Now uses Piscina worker threads for parallel CPU-bound processing.
+ */
+import { ManifestStore, type Manifest } from 'driftdetect-core';
+/**
+ * Project-wide context for detection
+ */
+export interface ProjectContext {
+    rootDir: string;
+    files: string[];
+    config: Record<string, unknown>;
+}
+/**
+ * Scanner service configuration
+ */
+export interface ScannerServiceConfig {
+    rootDir: string;
+    verbose?: boolean;
+    categories?: string[];
+    /** Only run critical/high-value detectors */
+    criticalOnly?: boolean;
+    /** Enable manifest generation */
+    generateManifest?: boolean;
+    /** Only scan changed files (incremental) */
+    incremental?: boolean;
+    /** Use worker threads for parallel processing */
+    useWorkerThreads?: boolean;
+    /** Number of worker threads (default: CPU cores - 1) */
+    workerThreads?: number;
+}
+/**
+ * Aggregated pattern match across files
+ *
+ * Enhanced to preserve all metadata from detectors including:
+ * - Full location range (endLine/endColumn)
+ * - Outlier information per location
+ * - Matched text for context
+ */
+export interface AggregatedPattern {
+    patternId: string;
+    detectorId: string;
+    category: string;
+    subcategory: string;
+    name: string;
+    description: string;
+    locations: Array<{
+        file: string;
+        line: number;
+        column: number;
+        /** End line for full range highlighting */
+        endLine?: number;
+        /** End column for full range highlighting */
+        endColumn?: number;
+        /** Whether this specific location is an outlier */
+        isOutlier?: boolean;
+        /** Reason for outlier classification */
+        outlierReason?: string;
+        /** The actual text that was matched */
+        matchedText?: string;
+        /** Per-location confidence score */
+        confidence?: number;
+    }>;
+    confidence: number;
+    occurrences: number;
+    /** Total number of outliers across all locations */
+    outlierCount: number;
+    /** Custom metadata from detectors */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Aggregated violation across files
+ */
+export interface AggregatedViolation {
+    patternId: string;
+    detectorId: string;
+    category: string;
+    severity: 'error' | 'warning' | 'info' | 'hint';
+    file: string;
+    line: number;
+    column: number;
+    message: string;
+    explanation?: string | undefined;
+    suggestedFix?: string | undefined;
+}
+/**
+ * Scan result for a single file
+ */
+export interface FileScanResult {
+    file: string;
+    patterns: Array<{
+        patternId: string;
+        detectorId: string;
+        confidence: number;
+        location: {
+            file: string;
+            line: number;
+            column: number;
+            endLine?: number;
+            endColumn?: number;
+        };
+        isOutlier?: boolean;
+        outlierReason?: string;
+        matchedText?: string;
+        metadata?: Record<string, unknown>;
+    }>;
+    violations: AggregatedViolation[];
+    duration: number;
+    error?: string | undefined;
+}
+/**
+ * Overall scan results
+ */
+export interface ScanResults {
+    files: FileScanResult[];
+    patterns: AggregatedPattern[];
+    violations: AggregatedViolation[];
+    totalPatterns: number;
+    totalViolations: number;
+    totalFiles: number;
+    duration: number;
+    errors: string[];
+    detectorStats: {
+        total: number;
+        ran: number;
+        skipped: number;
+    };
+    /** Manifest with semantic locations (if generateManifest is true) */
+    manifest?: Manifest | undefined;
+    /** Worker thread stats (if useWorkerThreads is true) */
+    workerStats?: {
+        threadsUsed: number;
+        tasksCompleted: number;
+    } | undefined;
+}
+/**
+ * Scanner Service
+ *
+ * Orchestrates pattern detection across files using real detectors.
+ * Supports both single-threaded and multi-threaded (Piscina) modes.
+ */
+export declare class ScannerService {
+    private config;
+    private detectors;
+    private initialized;
+    private manifestStore;
+    private pool;
+    private PiscinaClass;
+    constructor(config: ScannerServiceConfig);
+    /**
+     * Initialize the scanner service
+     */
+    initialize(): Promise<void>;
+    /**
+     * Warm up all worker threads by preloading detectors
+     * This runs warmup tasks in parallel so all workers load detectors simultaneously
+     */
+    private warmupWorkers;
+    /**
+     * Get detector count
+     */
+    getDetectorCount(): number;
+    /**
+     * Get detector counts by category
+     */
+    getDetectorCounts(): {
+        api: number;
+        auth: number;
+        security: number;
+        errors: number;
+        structural: number;
+        components: number;
+        styling: number;
+        logging: number;
+        testing: number;
+        dataAccess: number;
+        config: number;
+        types: number;
+        accessibility: number;
+        documentation: number;
+        performance: number;
+        total: number;
+    };
+    /**
+     * Check if worker threads are enabled and initialized
+     */
+    isUsingWorkerThreads(): boolean;
+    /**
+     * Get worker thread count
+     */
+    getWorkerThreadCount(): number;
+    /**
+     * Scan files for patterns
+     */
+    scanFiles(files: string[], projectContext: ProjectContext): Promise<ScanResults>;
+    /**
+     * Scan files using worker threads (parallel)
+     */
+    private scanFilesWithWorkers;
+    /**
+     * Aggregate results from worker threads
+     */
+    private aggregateWorkerResults;
+    /**
+     * Add pattern match to manifest
+     */
+    private addToManifest;
+    /**
+     * Scan files single-threaded (fallback)
+     */
+    private scanFilesSingleThreaded;
+    /**
+     * Create a semantic location from a basic location
+     */
+    private createSemanticLocation;
+    /**
+     * Extract semantic information from a line of code
+     */
+    private extractSemanticInfo;
+    /**
+     * Get the manifest store
+     */
+    getManifestStore(): ManifestStore | null;
+    /**
+     * Destroy the worker pool
+     */
+    destroy(): Promise<void>;
+}
+/**
+ * Create a scanner service
+ */
+export declare function createScannerService(config: ScannerServiceConfig): ScannerService;
+//# sourceMappingURL=scanner-service.d.ts.map

package/dist/types/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * CLI type exports
+ */
+export interface CLIOptions {
+    /** Enable verbose output */
+    verbose?: boolean;
+    /** Output format */
+    format?: 'text' | 'json' | 'github' | 'gitlab';
+    /** CI mode */
+    ci?: boolean;
+    /** Check only staged files */
+    staged?: boolean;
+}
+export interface CheckResult {
+    /** Number of violations */
+    violationCount: number;
+    /** Number of errors */
+    errorCount: number;
+    /** Number of warnings */
+    warningCount: number;
+    /** Exit code */
+    exitCode: number;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC/C,cAAc;IACd,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,8BAA8B;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,2BAA2B;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,yBAAyB;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/index.js

@@ -0,0 +1,5 @@
+/**
+ * CLI type exports
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/ui/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * UI module exports
+ *
+ * Provides CLI UI components for interactive prompts, spinners,
+ * tables, and progress bars.
+ */
+export { confirmPrompt, inputPrompt, selectPrompt, multiSelectPrompt, promptPatternAction, promptBatchPatternApproval, promptSeverity, promptVariantReason, promptVariantScope, promptInitOptions, promptIgnoreReason, promptReportFormat, promptCategorySelection, type PatternChoice, type PatternAction, type VariantScope, type InitPromptResult, type ReportFormat, } from './prompts.js';
+export { Spinner, createSpinner, withSpinner, spinners, status, type SpinnerOptions, } from './spinner.js';
+export { createTable, formatSeverity, formatConfidence, formatCount, formatPath, createPatternsTable, createViolationsTable, createSummaryTable, createStatusTable, createCategoryTable, type TableStyle, type TableOptions, type PatternRow, type ViolationRow, type SummaryRow, type StatusSummary, type CategoryBreakdown, } from './table.js';
+export { Progress, MultiProgress, createScanProgress, createAnalysisProgress, createDetectionProgress, withProgress, logProgress, type ProgressOptions, } from './progress.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/ui/index.js

@@ -0,0 +1,15 @@
+/**
+ * UI module exports
+ *
+ * Provides CLI UI components for interactive prompts, spinners,
+ * tables, and progress bars.
+ */
+// Prompts
+export { confirmPrompt, inputPrompt, selectPrompt, multiSelectPrompt, promptPatternAction, promptBatchPatternApproval, promptSeverity, promptVariantReason, promptVariantScope, promptInitOptions, promptIgnoreReason, promptReportFormat, promptCategorySelection, } from './prompts.js';
+// Spinner
+export { Spinner, createSpinner, withSpinner, spinners, status, } from './spinner.js';
+// Table
+export { createTable, formatSeverity, formatConfidence, formatCount, formatPath, createPatternsTable, createViolationsTable, createSummaryTable, createStatusTable, createCategoryTable, } from './table.js';
+// Progress
+export { Progress, MultiProgress, createScanProgress, createAnalysisProgress, createDetectionProgress, withProgress, logProgress, } from './progress.js';
+//# sourceMappingURL=index.js.map

package/dist/ui/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/ui/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,UAAU;AACV,OAAO,EACL,aAAa,EACb,WAAW,EACX,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,0BAA0B,EAC1B,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,GAMxB,MAAM,cAAc,CAAC;AAEtB,UAAU;AACV,OAAO,EACL,OAAO,EACP,aAAa,EACb,WAAW,EACX,QAAQ,EACR,MAAM,GAEP,MAAM,cAAc,CAAC;AAEtB,QAAQ;AACR,OAAO,EACL,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,GAQpB,MAAM,YAAY,CAAC;AAEpB,WAAW;AACX,OAAO,EACL,QAAQ,EACR,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,YAAY,EACZ,WAAW,GAEZ,MAAM,eAAe,CAAC"}

package/dist/ui/progress.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Progress - Progress bars for scanning
+ *
+ * Provides progress bars for long-running operations like scanning.
+ *
+ * @requirements 29.1
+ */
+import { SingleBar } from 'cli-progress';
+/**
+ * Progress bar configuration options
+ */
+export interface ProgressOptions {
+    /** Total number of items */
+    total: number;
+    /** Format string for the progress bar */
+    format?: string;
+    /** Whether to show ETA */
+    showEta?: boolean;
+    /** Whether to show percentage */
+    showPercentage?: boolean;
+    /** Whether to show value/total */
+    showValue?: boolean;
+    /** Whether progress is enabled (false in CI mode) */
+    enabled?: boolean;
+    /** Clear the bar on complete */
+    clearOnComplete?: boolean;
+    /** Hide cursor during progress */
+    hideCursor?: boolean;
+}
+/**
+ * Progress bar wrapper for consistent CLI feedback
+ */
+export declare class Progress {
+    private bar;
+    private enabled;
+    private currentValue;
+    constructor(options: ProgressOptions);
+    /**
+     * Update progress with current value
+     */
+    update(value: number, payload?: Record<string, string | number>): this;
+    /**
+     * Increment progress by amount
+     */
+    increment(amount?: number, payload?: Record<string, string | number>): this;
+    /**
+     * Set the current task description
+     */
+    task(description: string): this;
+    /**
+     * Set the total value
+     */
+    setTotal(total: number): this;
+    /**
+     * Stop the progress bar
+     */
+    stop(): this;
+    /**
+     * Get current value
+     */
+    get value(): number;
+}
+/**
+ * Multi-progress bar for parallel operations
+ */
+export declare class MultiProgress {
+    private multiBar;
+    private bars;
+    private enabled;
+    constructor(enabled?: boolean);
+    /**
+     * Create a new progress bar
+     */
+    create(name: string, total: number): SingleBar | null;
+    /**
+     * Update a specific bar
+     */
+    update(name: string, value: number, payload?: Record<string, string | number>): this;
+    /**
+     * Increment a specific bar
+     */
+    increment(name: string, amount?: number, payload?: Record<string, string | number>): this;
+    /**
+     * Remove a specific bar
+     */
+    remove(name: string): this;
+    /**
+     * Stop all progress bars
+     */
+    stop(): this;
+}
+/**
+ * Create a progress bar for scanning operations
+ */
+export declare function createScanProgress(totalFiles: number): Progress;
+/**
+ * Create a progress bar for analysis operations
+ */
+export declare function createAnalysisProgress(totalItems: number): Progress;
+/**
+ * Create a progress bar for pattern detection
+ */
+export declare function createDetectionProgress(totalDetectors: number): Progress;
+/**
+ * Run an operation with progress tracking
+ */
+export declare function withProgress<T>(items: T[], operation: (item: T, index: number) => Promise<void>, options?: {
+    format?: string;
+    getTaskName?: (item: T) => string;
+}): Promise<void>;
+/**
+ * Simple percentage display for CI mode
+ */
+export declare function logProgress(current: number, total: number, message?: string): void;
+//# sourceMappingURL=progress.d.ts.map

package/dist/ui/prompts.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Prompts - Interactive prompts with Inquirer
+ *
+ * Provides interactive prompts for user input during CLI operations.
+ *
+ * @requirements 29.8
+ */
+import type { Severity } from 'driftdetect-core';
+/**
+ * Pattern approval choice
+ */
+export interface PatternChoice {
+    /** Pattern ID */
+    id: string;
+    /** Pattern name */
+    name: string;
+    /** Pattern category */
+    category: string;
+    /** Confidence score */
+    confidence: number;
+}
+/**
+ * Prompt for confirmation
+ */
+export declare function confirmPrompt(message: string, defaultValue?: boolean): Promise<boolean>;
+/**
+ * Prompt for text input
+ */
+export declare function inputPrompt(message: string, defaultValue?: string): Promise<string>;
+/**
+ * Prompt to select from a list of options
+ */
+export declare function selectPrompt<T extends string>(message: string, choices: Array<{
+    value: T;
+    name: string;
+    description?: string;
+}>): Promise<T>;
+/**
+ * Prompt to select multiple items from a list
+ */
+export declare function multiSelectPrompt<T extends string>(message: string, choices: Array<{
+    value: T;
+    name: string;
+    checked?: boolean;
+}>): Promise<T[]>;
+/**
+ * Prompt for pattern approval action
+ */
+export type PatternAction = 'approve' | 'ignore' | 'skip' | 'variant';
+export declare function promptPatternAction(pattern: PatternChoice): Promise<PatternAction>;
+/**
+ * Prompt for multiple pattern approvals
+ */
+export declare function promptBatchPatternApproval(patterns: PatternChoice[]): Promise<string[]>;
+/**
+ * Prompt for severity selection
+ */
+export declare function promptSeverity(message?: string): Promise<Severity>;
+/**
+ * Prompt for variant reason
+ */
+export declare function promptVariantReason(): Promise<string>;
+/**
+ * Prompt for variant scope
+ */
+export type VariantScope = 'global' | 'directory' | 'file';
+export declare function promptVariantScope(): Promise<VariantScope>;
+/**
+ * Prompt for initialization options
+ */
+export interface InitPromptResult {
+    /** Whether to scan immediately */
+    scanNow: boolean;
+    /** Whether to auto-approve high confidence patterns */
+    autoApprove: boolean;
+}
+export declare function promptInitOptions(): Promise<InitPromptResult>;
+/**
+ * Prompt for ignore reason
+ */
+export declare function promptIgnoreReason(): Promise<string>;
+/**
+ * Prompt for report format selection
+ */
+export type ReportFormat = 'text' | 'json' | 'github' | 'gitlab';
+export declare function promptReportFormat(): Promise<ReportFormat>;
+/**
+ * Prompt for category selection
+ */
+export declare function promptCategorySelection(categories: string[]): Promise<string[]>;
+//# sourceMappingURL=prompts.d.ts.map

package/dist/ui/spinner.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Spinner - Progress spinners
+ *
+ * Provides animated spinners for long-running operations.
+ *
+ * @requirements 29.1
+ */
+/**
+ * Spinner configuration options
+ */
+export interface SpinnerOptions {
+    /** Spinner text */
+    text?: string;
+    /** Spinner color */
+    color?: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray';
+    /** Whether to show spinner (false in CI mode) */
+    enabled?: boolean;
+}
+/**
+ * Spinner wrapper for consistent CLI feedback
+ */
+export declare class Spinner {
+    private spinner;
+    private enabled;
+    constructor(options?: SpinnerOptions);
+    /**
+     * Start the spinner with optional text
+     */
+    start(text?: string): this;
+    /**
+     * Stop the spinner with a success message
+     */
+    succeed(text?: string): this;
+    /**
+     * Stop the spinner with a failure message
+     */
+    fail(text?: string): this;
+    /**
+     * Stop the spinner with a warning message
+     */
+    warn(text?: string): this;
+    /**
+     * Stop the spinner with an info message
+     */
+    info(text?: string): this;
+    /**
+     * Stop the spinner without a status symbol
+     */
+    stop(): this;
+    /**
+     * Update the spinner text
+     */
+    text(text: string): this;
+    /**
+     * Update the spinner color
+     */
+    color(color: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'): this;
+    /**
+     * Check if spinner is currently spinning
+     */
+    get isSpinning(): boolean;
+}
+/**
+ * Create a new spinner instance
+ */
+export declare function createSpinner(textOrOptions?: string | SpinnerOptions): Spinner;
+/**
+ * Run an async operation with a spinner
+ */
+export declare function withSpinner<T>(text: string, operation: () => Promise<T>, options?: {
+    successText?: string | ((result: T) => string);
+    failText?: string | ((error: Error) => string);
+}): Promise<T>;
+/**
+ * Pre-configured spinners for common operations
+ */
+export declare const spinners: {
+    /**
+     * Spinner for scanning operations
+     */
+    scanning(text?: string): Spinner;
+    /**
+     * Spinner for analysis operations
+     */
+    analyzing(text?: string): Spinner;
+    /**
+     * Spinner for loading operations
+     */
+    loading(text?: string): Spinner;
+    /**
+     * Spinner for saving operations
+     */
+    saving(text?: string): Spinner;
+    /**
+     * Spinner for checking operations
+     */
+    checking(text?: string): Spinner;
+};
+/**
+ * Status indicators for non-spinner output
+ */
+export declare const status: {
+    success(message: string): void;
+    error(message: string): void;
+    warning(message: string): void;
+    info(message: string): void;
+    pending(message: string): void;
+};
+//# sourceMappingURL=spinner.d.ts.map