driftdetect-detectors 0.1.0

package/dist/structural/co-location.d.ts

@@ -0,0 +1,202 @@
+/**
+ * Co-location Detector - Test and style co-location detection
+ *
+ * Detects test co-location patterns (tests next to source vs separate directories)
+ * and style co-location patterns (styles next to components vs separate directories).
+ *
+ * @requirements 7.3 - THE Structural_Detector SHALL detect co-location patterns (tests next to source vs separate)
+ */
+import type { Violation, QuickFix, Language } from 'driftdetect-core';
+import { StructuralDetector, type DetectionContext, type DetectionResult } from '../base/index.js';
+/**
+ * Types of co-location patterns
+ */
+export type CoLocationPattern = 'co-located' | 'separate' | 'mixed' | 'unknown';
+/**
+ * Common test file patterns
+ */
+export declare const TEST_FILE_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp];
+/**
+ * Common test directory names
+ */
+export declare const TEST_DIRECTORIES: readonly ["__tests__", "tests", "test", "__test__", "spec", "specs", "__specs__"];
+/**
+ * Common style file patterns
+ */
+export declare const STYLE_FILE_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp];
+/**
+ * Common style directory names
+ */
+export declare const STYLE_DIRECTORIES: readonly ["styles", "style", "css", "scss", "__styles__"];
+/**
+ * Information about a test file
+ */
+export interface TestFileInfo {
+    /** Test file path */
+    testFile: string;
+    /** Corresponding source file (if found) */
+    sourceFile: string | null;
+    /** Whether the test is co-located with source */
+    isCoLocated: boolean;
+    /** Test directory (if in a test directory) */
+    testDirectory: string | null;
+}
+/**
+ * Information about a style file
+ */
+export interface StyleFileInfo {
+    /** Style file path */
+    styleFile: string;
+    /** Corresponding component file (if found) */
+    componentFile: string | null;
+    /** Whether the style is co-located with component */
+    isCoLocated: boolean;
+    /** Style directory (if in a style directory) */
+    styleDirectory: string | null;
+}
+/**
+ * Analysis of test co-location patterns
+ */
+export interface TestCoLocationAnalysis {
+    /** Detected pattern type */
+    pattern: CoLocationPattern;
+    /** Confidence in the detection (0-1) */
+    confidence: number;
+    /** Co-located test files */
+    coLocatedTests: TestFileInfo[];
+    /** Separate test files (in test directories) */
+    separateTests: TestFileInfo[];
+    /** Total test files analyzed */
+    totalTestFiles: number;
+    /** Percentage of co-located tests */
+    coLocationRatio: number;
+}
+/**
+ * Analysis of style co-location patterns
+ */
+export interface StyleCoLocationAnalysis {
+    /** Detected pattern type */
+    pattern: CoLocationPattern;
+    /** Confidence in the detection (0-1) */
+    confidence: number;
+    /** Co-located style files */
+    coLocatedStyles: StyleFileInfo[];
+    /** Separate style files (in style directories) */
+    separateStyles: StyleFileInfo[];
+    /** Total style files analyzed */
+    totalStyleFiles: number;
+    /** Percentage of co-located styles */
+    coLocationRatio: number;
+}
+/**
+ * Combined co-location analysis
+ */
+export interface CoLocationAnalysis {
+    /** Test co-location analysis */
+    tests: TestCoLocationAnalysis;
+    /** Style co-location analysis */
+    styles: StyleCoLocationAnalysis;
+    /** Overall confidence */
+    confidence: number;
+}
+/**
+ * Check if a file is a test file
+ */
+export declare function isTestFile(filePath: string): boolean;
+/**
+ * Check if a file is in a test directory
+ */
+export declare function isInTestDirectory(filePath: string): boolean;
+/**
+ * Get the test directory from a file path (if any)
+ */
+export declare function getTestDirectory(filePath: string): string | null;
+/**
+ * Check if a file is a style file
+ */
+export declare function isStyleFile(filePath: string): boolean;
+/**
+ * Check if a file is in a style directory
+ */
+export declare function isInStyleDirectory(filePath: string): boolean;
+/**
+ * Get the style directory from a file path (if any)
+ */
+export declare function getStyleDirectory(filePath: string): string | null;
+/**
+ * Extract the base name from a test file (remove test suffix)
+ */
+export declare function extractTestBaseName(testFile: string): string;
+/**
+ * Extract the base name from a style file (remove style suffix)
+ */
+export declare function extractStyleBaseName(styleFile: string): string;
+/**
+ * Get the directory of a file
+ */
+export declare function getFileDirectory(filePath: string): string;
+/**
+ * Find the corresponding source file for a test file
+ */
+export declare function findSourceFileForTest(testFile: string, allFiles: string[]): string | null;
+/**
+ * Find the corresponding component file for a style file
+ */
+export declare function findComponentFileForStyle(styleFile: string, allFiles: string[]): string | null;
+/**
+ * Analyze test co-location patterns in a project
+ */
+export declare function analyzeTestCoLocation(files: string[]): TestCoLocationAnalysis;
+/**
+ * Analyze style co-location patterns in a project
+ */
+export declare function analyzeStyleCoLocation(files: string[]): StyleCoLocationAnalysis;
+/**
+ * Analyze all co-location patterns in a project
+ */
+export declare function analyzeCoLocation(files: string[]): CoLocationAnalysis;
+/**
+ * Detector for co-location patterns
+ *
+ * Identifies whether a project uses co-located tests/styles (next to source)
+ * or separate directories for tests and styles.
+ *
+ * @requirements 7.3 - THE Structural_Detector SHALL detect co-location patterns
+ */
+export declare class CoLocationDetector extends StructuralDetector {
+    readonly id = "structural/co-location";
+    readonly category: "structural";
+    readonly subcategory = "co-location";
+    readonly name = "Co-location Detector";
+    readonly description = "Detects test and style co-location patterns (co-located vs separate directories)";
+    readonly supportedLanguages: Language[];
+    /**
+     * Detect co-location patterns in the project
+     */
+    detect(context: DetectionContext): Promise<DetectionResult>;
+    /**
+     * Generate a quick fix for co-location violations
+     */
+    generateQuickFix(violation: Violation): QuickFix | null;
+    /**
+     * Create a pattern match for test co-location
+     */
+    private createTestCoLocationPattern;
+    /**
+     * Create a pattern match for style co-location
+     */
+    private createStyleCoLocationPattern;
+    /**
+     * Check if the current file follows the project's test co-location pattern
+     */
+    private checkTestCoLocationConsistency;
+    /**
+     * Check if the current file follows the project's style co-location pattern
+     */
+    private checkStyleCoLocationConsistency;
+}
+/**
+ * Create a new CoLocationDetector instance
+ */
+export declare function createCoLocationDetector(): CoLocationDetector;
+//# sourceMappingURL=co-location.d.ts.map

package/dist/structural/co-location.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"co-location.d.ts","sourceRoot":"","sources":["../../src/structural/co-location.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAS,MAAM,kBAAkB,CAAC;AAC3F,OAAO,EAAE,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAMnG;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,kBAAkB,2CAKrB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,gBAAgB,mFAQnB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,mBAAmB,2FAWtB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,iBAAiB,2DAMpB,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,iDAAiD;IACjD,WAAW,EAAE,OAAO,CAAC;IACrB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,qDAAqD;IACrD,WAAW,EAAE,OAAO,CAAC;IACrB,gDAAgD;IAChD,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,4BAA4B;IAC5B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B,gDAAgD;IAChD,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,gCAAgC;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,4BAA4B;IAC5B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,6BAA6B;IAC7B,eAAe,EAAE,aAAa,EAAE,CAAC;IACjC,kDAAkD;IAClD,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,iCAAiC;IACjC,eAAe,EAAE,MAAM,CAAC;IACxB,sCAAsC;IACtC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,gCAAgC;IAChC,KAAK,EAAE,sBAAsB,CAAC;IAC9B,iCAAiC;IACjC,MAAM,EAAE,uBAAuB,CAAC;IAChC,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAYpD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAY3D;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAahE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAYrD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAY5D;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAajE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAY5D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAkB9D;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIzD;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAiDzF;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAiD9F;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,sBAAsB,CA4D7E;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,uBAAuB,CA4D/E;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAqBrE;AAMD;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,kBAAkB;IACxD,QAAQ,CAAC,EAAE,4BAA4B;IACvC,QAAQ,CAAC,QAAQ,EAAG,YAAY,CAAU;IAC1C,QAAQ,CAAC,WAAW,iBAAiB;IACrC,QAAQ,CAAC,IAAI,0BAA0B;IACvC,QAAQ,CAAC,WAAW,sFAAsF;IAC1G,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,EAAE,CAKrC;IAEF;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IA8BjE;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI;IAiCvD;;OAEG;IACH,OAAO,CAAC,2BAA2B;IAYnC;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAYpC;;OAEG;IACH,OAAO,CAAC,8BAA8B;IA8DtC;;OAEG;IACH,OAAO,CAAC,+BAA+B;CA6DxC;AAMD;;GAEG;AACH,wBAAgB,wBAAwB,IAAI,kBAAkB,CAE7D"}