driftdetect-detectors 0.1.0

package/dist/structural/package-boundaries.d.ts

@@ -0,0 +1,182 @@
+/**
+ * Package Boundaries Detector - Monorepo boundary violation detection
+ *
+ * Detects monorepo package boundary violations including:
+ * - Direct imports between packages that bypass the public API
+ * - Imports from packages that are not declared as dependencies
+ * - Cross-package imports that violate the dependency hierarchy
+ * - Internal module access (importing from src/ instead of package entry point)
+ *
+ * @requirements 7.8 - THE Structural_Detector SHALL detect package boundary violations in monorepos
+ */
+import type { Violation, QuickFix, Language } from 'driftdetect-core';
+import { StructuralDetector, type DetectionContext, type DetectionResult } from '../base/index.js';
+/**
+ * Type of package boundary violation
+ */
+export type PackageBoundaryViolationType = 'internal-import' | 'undeclared-dependency' | 'hierarchy-violation' | 'bypass-public-api';
+/**
+ * Severity level for package boundary violations
+ */
+export type PackageBoundarySeverity = 'error' | 'warning' | 'info';
+/**
+ * Information about a detected package
+ */
+export interface PackageInfo {
+    /** Package name (e.g., driftdetect-core) */
+    name: string;
+    /** Package directory path */
+    path: string;
+    /** Dependencies declared in package.json */
+    dependencies: string[];
+    /** Dev dependencies declared in package.json */
+    devDependencies: string[];
+    /** Peer dependencies declared in package.json */
+    peerDependencies: string[];
+    /** Entry point (main or exports) */
+    entryPoint?: string;
+}
+/**
+ * Information about a package boundary violation
+ */
+export interface PackageBoundaryViolationInfo {
+    /** Type of violation */
+    type: PackageBoundaryViolationType;
+    /** The import source path */
+    importSource: string;
+    /** The package being imported from */
+    targetPackage: string;
+    /** The package containing the importing file */
+    sourcePackage: string;
+    /** Line number of the import */
+    line: number;
+    /** Calculated severity */
+    severity: PackageBoundarySeverity;
+    /** Human-readable description */
+    description: string;
+    /** Suggested correct import path */
+    suggestedImport?: string;
+}
+/**
+ * Analysis result for package boundaries
+ */
+export interface PackageBoundaryAnalysis {
+    /** Whether the file is in a monorepo package */
+    isInMonorepo: boolean;
+    /** Current package info (if in a package) */
+    currentPackage: PackageInfo | null;
+    /** All detected packages in the monorepo */
+    packages: PackageInfo[];
+    /** Violations found */
+    violations: PackageBoundaryViolationInfo[];
+    /** Total cross-package imports analyzed */
+    totalCrossPackageImports: number;
+}
+/**
+ * Monorepo configuration
+ */
+export interface MonorepoConfig {
+    /** Package directory patterns (e.g., ['packages/*', 'apps/*']) */
+    packagePatterns: string[];
+    /** Whether to allow internal imports within the same package */
+    allowInternalImports: boolean;
+    /** Custom package name to path mappings */
+    packageMappings?: Record<string, string>;
+}
+/**
+ * Common monorepo package directory patterns
+ */
+export declare const COMMON_PACKAGE_PATTERNS: string[];
+/**
+ * Patterns that indicate internal/private paths
+ */
+export declare const INTERNAL_PATH_PATTERNS: string[];
+/**
+ * Default monorepo configuration
+ */
+export declare const DEFAULT_MONOREPO_CONFIG: MonorepoConfig;
+/**
+ * Extract package name from an import path
+ * Handles scoped packages (@org/package) and regular packages
+ */
+export declare function extractPackageName(importPath: string): string | null;
+/**
+ * Check if an import path accesses internal package paths
+ */
+export declare function isInternalImport(importPath: string): boolean;
+/**
+ * Check if an import bypasses the public API
+ * (imports from internal paths instead of the package entry point)
+ */
+export declare function bypassesPublicApi(importPath: string, packageName: string): boolean;
+/**
+ * Detect packages in a monorepo from file paths
+ */
+export declare function detectMonorepoPackages(files: string[], config?: MonorepoConfig): PackageInfo[];
+/**
+ * Find which package a file belongs to
+ */
+export declare function findPackageForFile(filePath: string, packages: PackageInfo[]): PackageInfo | null;
+/**
+ * Resolve an import to determine which package it targets
+ */
+export declare function resolveImportToPackage(importSource: string, currentFile: string, packages: PackageInfo[]): PackageInfo | null;
+/**
+ * Check if a package is declared as a dependency
+ */
+export declare function isDeclaredDependency(targetPackage: string, sourcePackage: PackageInfo): boolean;
+/**
+ * Generate a suggested import path for a violation
+ */
+export declare function generateSuggestedImport(violation: PackageBoundaryViolationInfo): string | undefined;
+/**
+ * Calculate severity for a package boundary violation
+ */
+export declare function calculateViolationSeverity(type: PackageBoundaryViolationType): PackageBoundarySeverity;
+/**
+ * Analyze package boundaries for a file
+ */
+export declare function analyzePackageBoundaries(file: string, imports: Array<{
+    source: string;
+    line: number;
+}>, projectFiles: string[], config?: MonorepoConfig): PackageBoundaryAnalysis;
+/**
+ * Detector for monorepo package boundary violations
+ *
+ * Identifies violations including:
+ * - Direct imports between packages that bypass the public API
+ * - Imports from packages that are not declared as dependencies
+ * - Cross-package imports that violate the dependency hierarchy
+ * - Internal module access (importing from src/ instead of package entry point)
+ *
+ * @requirements 7.8 - THE Structural_Detector SHALL detect package boundary violations in monorepos
+ */
+export declare class PackageBoundariesDetector extends StructuralDetector {
+    readonly id = "structural/package-boundaries";
+    readonly category: "structural";
+    readonly subcategory = "package-boundaries";
+    readonly name = "Package Boundaries Detector";
+    readonly description = "Detects monorepo package boundary violations including internal imports and undeclared dependencies";
+    readonly supportedLanguages: Language[];
+    /**
+     * Detect package boundary violations in the project
+     */
+    detect(context: DetectionContext): Promise<DetectionResult>;
+    /**
+     * Generate a quick fix for package boundary violations
+     */
+    generateQuickFix(violation: Violation): QuickFix | null;
+    /**
+     * Extract imports from the detection context
+     */
+    private extractImports;
+    /**
+     * Create a violation for a package boundary issue
+     */
+    private createBoundaryViolation;
+}
+/**
+ * Create a new PackageBoundariesDetector instance
+ */
+export declare function createPackageBoundariesDetector(): PackageBoundariesDetector;
+//# sourceMappingURL=package-boundaries.d.ts.map

package/dist/structural/package-boundaries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-boundaries.d.ts","sourceRoot":"","sources":["../../src/structural/package-boundaries.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;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,4BAA4B,GACpC,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,mBAAmB,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,gDAAgD;IAChD,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wBAAwB;IACxB,IAAI,EAAE,4BAA4B,CAAC;IACnC,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,QAAQ,EAAE,uBAAuB,CAAC;IAClC,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,gDAAgD;IAChD,YAAY,EAAE,OAAO,CAAC;IACtB,6CAA6C;IAC7C,cAAc,EAAE,WAAW,GAAG,IAAI,CAAC;IACnC,4CAA4C;IAC5C,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,uBAAuB;IACvB,UAAU,EAAE,4BAA4B,EAAE,CAAC;IAC3C,2CAA2C;IAC3C,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kEAAkE;IAClE,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,gEAAgE;IAChE,oBAAoB,EAAE,OAAO,CAAC;IAC9B,2CAA2C;IAC3C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAMD;;GAEG;AACH,eAAO,MAAM,uBAAuB,UAMnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,UAQlC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,cAGrC,CAAC;AAaF;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAkBpE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAuB5D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAoBlF;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EAAE,EACf,MAAM,GAAE,cAAwC,GAC/C,WAAW,EAAE,CA2Df;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW,EAAE,GACtB,WAAW,GAAG,IAAI,CAmBpB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,WAAW,EAAE,GACtB,WAAW,GAAG,IAAI,CAsDpB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,WAAW,GACzB,OAAO,CAQT;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,4BAA4B,GACtC,MAAM,GAAG,SAAS,CAkBpB;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,4BAA4B,GACjC,uBAAuB,CAazB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,KAAK,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,EAChD,YAAY,EAAE,MAAM,EAAE,EACtB,MAAM,GAAE,cAAwC,GAC/C,uBAAuB,CAwHzB;AAMD;;;;;;;;;;GAUG;AACH,qBAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,QAAQ,CAAC,EAAE,mCAAmC;IAC9C,QAAQ,CAAC,QAAQ,EAAG,YAAY,CAAU;IAC1C,QAAQ,CAAC,WAAW,wBAAwB;IAC5C,QAAQ,CAAC,IAAI,iCAAiC;IAC9C,QAAQ,CAAC,WAAW,yGAAyG;IAC7H,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,EAAE,CAGrC;IAEF;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IA+DjE;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI;IA2CvD;;OAEG;IACH,OAAO,CAAC,cAAc;IAqCtB;;OAEG;IACH,OAAO,CAAC,uBAAuB;CA0ChC;AAMD;;GAEG;AACH,wBAAgB,+BAA+B,IAAI,yBAAyB,CAE3E"}