driftdetect-detectors 0.1.0

package/dist/components/composition.d.ts

@@ -0,0 +1,287 @@
+/**
+ * Composition Detector - Component composition pattern detection
+ *
+ * Detects composition patterns including children prop usage, render props,
+ * Higher-Order Components (HOCs), compound components, slot-based composition,
+ * Provider/Consumer patterns, and controlled vs uncontrolled components.
+ *
+ * @requirements 8.6 - THE Component_Detector SHALL detect component composition patterns
+ */
+import type { Violation, QuickFix, Language, ASTNode } from 'driftdetect-core';
+import { ASTDetector, type DetectionContext, type DetectionResult } from '../base/index.js';
+/**
+ * Types of composition patterns
+ */
+export type CompositionPattern = 'children-prop' | 'render-props' | 'hoc' | 'compound-component' | 'slot-based' | 'provider-consumer' | 'controlled' | 'uncontrolled' | 'forwarded-ref' | 'none';
+/**
+ * Types of composition anti-patterns
+ */
+export type CompositionAntiPattern = 'deeply-nested-hocs' | 'prop-drilling' | 'missing-children' | 'overuse-render-props' | 'mixed-controlled' | 'excessive-context';
+/**
+ * Information about a composition pattern usage
+ */
+export interface CompositionUsageInfo {
+    /** Type of composition pattern */
+    pattern: CompositionPattern;
+    /** Component name where pattern is used */
+    componentName: string;
+    /** Line number where pattern is detected */
+    line: number;
+    /** Column number */
+    column: number;
+    /** Additional details about the pattern */
+    details: CompositionDetails;
+}
+/**
+ * Details about a specific composition pattern
+ */
+export interface CompositionDetails {
+    /** For render props: the prop names used */
+    renderPropNames?: string[];
+    /** For HOCs: the HOC names wrapping the component */
+    hocNames?: string[];
+    /** For compound components: the sub-component names */
+    subComponentNames?: string[];
+    /** For slots: the slot names */
+    slotNames?: string[];
+    /** For controlled: the controlled prop names */
+    controlledProps?: string[];
+    /** For provider: the context name */
+    contextName?: string;
+    /** Nesting depth (for HOCs, providers) */
+    nestingDepth?: number;
+}
+/**
+ * Information about a component's composition patterns
+ */
+export interface ComponentCompositionInfo {
+    /** Component name */
+    componentName: string;
+    /** File path */
+    filePath: string;
+    /** Line number where component is defined */
+    line: number;
+    /** Column number */
+    column: number;
+    /** Composition patterns used */
+    patterns: CompositionUsageInfo[];
+    /** Anti-patterns detected */
+    antiPatterns: CompositionAntiPatternInfo[];
+    /** Whether component accepts children */
+    acceptsChildren: boolean;
+    /** Whether component uses render props */
+    usesRenderProps: boolean;
+    /** Whether component is a HOC */
+    isHOC: boolean;
+    /** Whether component is part of compound component */
+    isCompoundComponent: boolean;
+    /** Whether component is controlled */
+    isControlled: boolean;
+}
+/**
+ * Information about a detected anti-pattern
+ */
+export interface CompositionAntiPatternInfo {
+    /** Type of anti-pattern */
+    type: CompositionAntiPattern;
+    /** Description of the issue */
+    description: string;
+    /** Severity level */
+    severity: 'error' | 'warning' | 'info';
+    /** Suggestion for fixing */
+    suggestion: string;
+    /** Line number where issue occurs */
+    line: number;
+    /** Column number */
+    column: number;
+}
+/**
+ * Analysis of composition patterns in a project
+ */
+export interface CompositionAnalysis {
+    /** All analyzed components */
+    components: ComponentCompositionInfo[];
+    /** Dominant composition pattern */
+    dominantPattern: CompositionPattern;
+    /** Pattern usage counts */
+    patternCounts: Record<CompositionPattern, number>;
+    /** Confidence score */
+    confidence: number;
+    /** Components with anti-patterns */
+    componentsWithAntiPatterns: ComponentCompositionInfo[];
+    /** Overall composition health score (0-1) */
+    healthScore: number;
+}
+/**
+ * Configuration for composition pattern detection
+ */
+export interface CompositionConfig {
+    /** Maximum HOC nesting depth before flagging */
+    maxHOCDepth: number;
+    /** Maximum render props per component */
+    maxRenderProps: number;
+    /** Maximum context providers nesting */
+    maxContextNesting: number;
+    /** Whether to detect controlled/uncontrolled patterns */
+    detectControlledPatterns: boolean;
+    /** Whether to flag prop drilling */
+    flagPropDrilling: boolean;
+}
+/**
+ * Default configuration for composition pattern detection
+ */
+export declare const DEFAULT_COMPOSITION_CONFIG: CompositionConfig;
+/**
+ * Common HOC patterns
+ */
+export declare const HOC_PATTERNS: readonly ["withRouter", "withStyles", "withTheme", "withAuth", "withLoading", "withErrorBoundary", "connect", "memo", "forwardRef", "observer"];
+/**
+ * Common render prop names
+ */
+export declare const RENDER_PROP_NAMES: readonly ["render", "children", "renderItem", "renderHeader", "renderFooter", "renderEmpty", "renderLoading", "renderError", "component"];
+/**
+ * Controlled component prop patterns
+ */
+export declare const CONTROLLED_PROP_PATTERNS: readonly [{
+    readonly value: "value";
+    readonly onChange: "onChange";
+}, {
+    readonly value: "checked";
+    readonly onChange: "onChange";
+}, {
+    readonly value: "selected";
+    readonly onChange: "onSelect";
+}, {
+    readonly value: "open";
+    readonly onChange: "onOpenChange";
+}, {
+    readonly value: "visible";
+    readonly onChange: "onVisibleChange";
+}, {
+    readonly value: "expanded";
+    readonly onChange: "onExpandedChange";
+}];
+/**
+ * Uncontrolled component prop patterns
+ */
+export declare const UNCONTROLLED_PROP_PATTERNS: readonly ["defaultValue", "defaultChecked", "defaultSelected", "defaultOpen", "defaultVisible", "defaultExpanded"];
+/**
+ * Check if a node represents a React component
+ */
+export declare function isReactComponent(node: ASTNode, content: string): boolean;
+/**
+ * Get the component name from a node
+ */
+export declare function getComponentName(node: ASTNode, content: string): string | undefined;
+/**
+ * Detect children prop usage in a component
+ */
+export declare function detectChildrenProp(nodeText: string): CompositionUsageInfo | null;
+/**
+ * Check if component accepts children prop
+ */
+export declare function acceptsChildrenProp(nodeText: string): boolean;
+/**
+ * Detect render props pattern in a component
+ */
+export declare function detectRenderProps(nodeText: string): CompositionUsageInfo | null;
+/**
+ * Detect Higher-Order Component pattern
+ */
+export declare function detectHOC(content: string): CompositionUsageInfo[];
+/**
+ * Extract HOC names from a chain like withA(withB(Component))
+ */
+export declare function extractHOCNames(hocChain: string): string[];
+/**
+ * Detect compound component pattern
+ */
+export declare function detectCompoundComponent(content: string): CompositionUsageInfo[];
+/**
+ * Check if component is part of a compound component pattern
+ */
+export declare function isCompoundComponentPart(componentName: string, content: string): boolean;
+/**
+ * Detect slot-based composition pattern
+ */
+export declare function detectSlotBasedComposition(nodeText: string): CompositionUsageInfo | null;
+/**
+ * Detect Provider/Consumer pattern
+ */
+export declare function detectProviderConsumer(content: string): CompositionUsageInfo[];
+/**
+ * Count nested providers in content
+ */
+export declare function countNestedProviders(content: string): number;
+/**
+ * Detect controlled component pattern
+ */
+export declare function detectControlledPattern(nodeText: string): CompositionUsageInfo | null;
+/**
+ * Detect uncontrolled component pattern
+ */
+export declare function detectUncontrolledPattern(nodeText: string): CompositionUsageInfo | null;
+/**
+ * Check if component mixes controlled and uncontrolled patterns
+ */
+export declare function hasMixedControlledPatterns(nodeText: string): boolean;
+/**
+ * Detect composition anti-patterns
+ */
+export declare function detectAntiPatterns(nodeText: string, content: string, config: CompositionConfig): CompositionAntiPatternInfo[];
+/**
+ * Analyze a single component's composition patterns
+ */
+export declare function analyzeComponentComposition(node: ASTNode, content: string, filePath: string, config: CompositionConfig): ComponentCompositionInfo | null;
+/**
+ * Analyze composition patterns across multiple components
+ */
+export declare function analyzeCompositionPatterns(components: ComponentCompositionInfo[]): CompositionAnalysis;
+/**
+ * Detector for component composition patterns
+ *
+ * Identifies composition patterns including children prop usage, render props,
+ * HOCs, compound components, and more. Reports anti-patterns and suggests
+ * improvements.
+ *
+ * @requirements 8.6 - THE Component_Detector SHALL detect component composition patterns
+ */
+export declare class CompositionDetector extends ASTDetector {
+    readonly id = "components/composition";
+    readonly category: "components";
+    readonly subcategory = "composition";
+    readonly name = "Composition Pattern Detector";
+    readonly description = "Detects component composition patterns (children, render props, HOCs, compound components) and identifies anti-patterns";
+    readonly supportedLanguages: Language[];
+    private config;
+    constructor(config?: Partial<CompositionConfig>);
+    /**
+     * Detect composition patterns in the project
+     */
+    detect(context: DetectionContext): Promise<DetectionResult>;
+    /**
+     * Find all React components in a file
+     */
+    private findComponentsInFile;
+    /**
+     * Find components using regex (fallback when AST is not available)
+     */
+    private findComponentsWithRegex;
+    /**
+     * Create a pattern match for a composition pattern
+     */
+    private createPatternMatch;
+    /**
+     * Create a violation for an anti-pattern
+     */
+    private createAntiPatternViolation;
+    /**
+     * Generate a quick fix for composition violations
+     */
+    generateQuickFix(violation: Violation): QuickFix | null;
+}
+/**
+ * Create a new CompositionDetector instance
+ */
+export declare function createCompositionDetector(config?: Partial<CompositionConfig>): CompositionDetector;
+//# sourceMappingURL=composition.d.ts.map

package/dist/components/composition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"composition.d.ts","sourceRoot":"","sources":["../../src/components/composition.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAgB,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAS,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACpG,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAM5F;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,cAAc,GACd,KAAK,GACL,oBAAoB,GACpB,YAAY,GACZ,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,eAAe,GACf,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,oBAAoB,GACpB,eAAe,GACf,kBAAkB,GAClB,sBAAsB,GACtB,kBAAkB,GAClB,mBAAmB,CAAC;AAGxB;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,kCAAkC;IAClC,OAAO,EAAE,kBAAkB,CAAC;IAC5B,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,uDAAuD;IACvD,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,gDAAgD;IAChD,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,qBAAqB;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC,6BAA6B;IAC7B,YAAY,EAAE,0BAA0B,EAAE,CAAC;IAC3C,yCAAyC;IACzC,eAAe,EAAE,OAAO,CAAC;IACzB,0CAA0C;IAC1C,eAAe,EAAE,OAAO,CAAC;IACzB,iCAAiC;IACjC,KAAK,EAAE,OAAO,CAAC;IACf,sDAAsD;IACtD,mBAAmB,EAAE,OAAO,CAAC;IAC7B,sCAAsC;IACtC,YAAY,EAAE,OAAO,CAAC;CACvB;AAGD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,2BAA2B;IAC3B,IAAI,EAAE,sBAAsB,CAAC;IAC7B,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB;IACrB,QAAQ,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACvC,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,8BAA8B;IAC9B,UAAU,EAAE,wBAAwB,EAAE,CAAC;IACvC,mCAAmC;IACnC,eAAe,EAAE,kBAAkB,CAAC;IACpC,2BAA2B;IAC3B,aAAa,EAAE,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IAClD,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,0BAA0B,EAAE,wBAAwB,EAAE,CAAC;IACvD,6CAA6C;IAC7C,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAC;IACpB,yCAAyC;IACzC,cAAc,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,yDAAyD;IACzD,wBAAwB,EAAE,OAAO,CAAC;IAClC,oCAAoC;IACpC,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAOD;;GAEG;AACH,eAAO,MAAM,0BAA0B,EAAE,iBAMxC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,iJAWf,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,iBAAiB,2IAUpB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;EAO3B,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,0BAA0B,oHAO7B,CAAC;AAOX;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAYxE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAenF;AAOD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI,CA4BhF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAW7D;AAOD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI,CAiD/E;AAOD;;GAEG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,oBAAoB,EAAE,CA0EjE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAY1D;AAOD;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,oBAAoB,EAAE,CAkD/E;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAQvF;AAOD;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI,CAyExF;AAOD;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,oBAAoB,EAAE,CAwE9E;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAG5D;AAOD;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI,CAyBrF;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI,CA+BvF;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAKpE;AAOD;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,iBAAiB,GACxB,0BAA0B,EAAE,CA+E9B;AAOD;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,iBAAiB,GACxB,wBAAwB,GAAG,IAAI,CAqFjC;AAiCD;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,wBAAwB,EAAE,GACrC,mBAAmB,CAkErB;AAoBD;;;;;;;;GAQG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD,QAAQ,CAAC,EAAE,4BAA4B;IACvC,QAAQ,CAAC,QAAQ,EAAG,YAAY,CAAU;IAC1C,QAAQ,CAAC,WAAW,iBAAiB;IACrC,QAAQ,CAAC,IAAI,kCAAkC;IAC/C,QAAQ,CAAC,WAAW,6HAA6H;IACjJ,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,EAAE,CAAgC;IAEvE,OAAO,CAAC,MAAM,CAAoB;gBAEtB,MAAM,GAAE,OAAO,CAAC,iBAAiB,CAAM;IAKnD;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IA2CjE;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAiC5B;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAwI/B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;OAEG;IACH,OAAO,CAAC,0BAA0B;IA2BlC;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI;CAoExD;AAMD;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,GAAE,OAAO,CAAC,iBAAiB,CAAM,GACtC,mBAAmB,CAErB"}