driftdetect-detectors 0.1.0

package/dist/styling/class-naming.d.ts

@@ -0,0 +1,263 @@
+/**
+ * Class Naming Detector - CSS class naming convention detection
+ *
+ * Detects CSS class naming patterns including:
+ * - BEM pattern (block__element--modifier)
+ * - Utility-first pattern (Tailwind-style: flex, items-center, p-4)
+ * - CSS Modules pattern (styles.className)
+ * - Semantic naming pattern (btn-primary, card-header)
+ * - SMACSS/OOCSS patterns
+ *
+ * Flags inconsistent class naming:
+ * - Mixed naming conventions in the same file
+ * - Non-standard BEM usage
+ * - Inconsistent utility class ordering
+ *
+ * @requirements 9.5 - THE Styling_Detector SHALL detect CSS class naming conventions (BEM, utility-first)
+ */
+import type { Violation, QuickFix, Language } from 'driftdetect-core';
+import { RegexDetector, type DetectionContext, type DetectionResult } from '../base/index.js';
+/**
+ * Types of class naming patterns detected
+ */
+export type ClassNamingPatternType = 'bem' | 'utility-first' | 'css-modules' | 'semantic' | 'smacss' | 'oocss';
+/**
+ * Types of class naming violations detected
+ */
+export type ClassNamingViolationType = 'mixed-conventions' | 'invalid-bem' | 'inconsistent-ordering' | 'non-semantic-name';
+/**
+ * Information about a detected class naming pattern
+ */
+export interface ClassNamingPatternInfo {
+    /** Type of class naming pattern */
+    type: ClassNamingPatternType;
+    /** File path */
+    file: string;
+    /** Line number (1-indexed) */
+    line: number;
+    /** Column number (1-indexed) */
+    column: number;
+    /** The matched text */
+    matchedText: string;
+    /** Class name(s) detected */
+    classNames: string[];
+    /** Additional context */
+    context?: string;
+}
+/**
+ * Information about a detected class naming violation
+ */
+export interface ClassNamingViolationInfo {
+    /** Type of class naming violation */
+    type: ClassNamingViolationType;
+    /** File path */
+    file: string;
+    /** Line number (1-indexed) */
+    line: number;
+    /** Column number (1-indexed) */
+    column: number;
+    /** End line number (1-indexed) */
+    endLine: number;
+    /** End column number (1-indexed) */
+    endColumn: number;
+    /** The problematic class name(s) */
+    classNames: string[];
+    /** Description of the issue */
+    issue: string;
+    /** Suggested fix */
+    suggestedFix?: string;
+    /** The full line content */
+    lineContent: string;
+}
+/**
+ * Analysis of class naming patterns in a file
+ */
+export interface ClassNamingAnalysis {
+    /** Class naming patterns found */
+    patterns: ClassNamingPatternInfo[];
+    /** Class naming violations found */
+    violations: ClassNamingViolationInfo[];
+    /** Whether file uses BEM naming */
+    usesBEM: boolean;
+    /** Whether file uses utility-first naming */
+    usesUtilityFirst: boolean;
+    /** Whether file uses CSS Modules */
+    usesCSSModules: boolean;
+    /** Whether file uses semantic naming */
+    usesSemantic: boolean;
+    /** Whether file uses SMACSS patterns */
+    usesSMACSS: boolean;
+    /** Dominant naming convention in the file */
+    dominantConvention: ClassNamingPatternType | null;
+    /** Confidence score for consistent naming */
+    namingConsistencyConfidence: number;
+}
+/**
+ * BEM pattern regex
+ * Matches: block, block__element, block--modifier, block__element--modifier
+ */
+export declare const BEM_PATTERN: RegExp;
+/**
+ * Strict BEM pattern (requires at least __ or --)
+ */
+export declare const STRICT_BEM_PATTERN: RegExp;
+/**
+ * Invalid BEM patterns (common mistakes)
+ */
+export declare const INVALID_BEM_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp, RegExp];
+/**
+ * Tailwind utility class patterns
+ */
+export declare const TAILWIND_UTILITY_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp];
+/**
+ * CSS Modules pattern
+ * Matches: styles.className, styles['class-name'], styles["class-name"]
+ */
+export declare const CSS_MODULES_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp, RegExp];
+/**
+ * Semantic naming patterns
+ * Matches: btn-primary, card-header, nav-item, etc.
+ */
+export declare const SEMANTIC_NAMING_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp];
+/**
+ * SMACSS patterns
+ * Matches: l-*, is-*, has-*, js-*
+ */
+export declare const SMACSS_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp];
+/**
+ * OOCSS patterns (common object-oriented CSS patterns)
+ */
+export declare const OOCSS_PATTERNS: readonly [RegExp, RegExp, RegExp];
+/**
+ * File patterns to exclude from class naming detection
+ */
+export declare const EXCLUDED_FILE_PATTERNS: RegExp[];
+/**
+ * Recommended utility class ordering (Tailwind convention)
+ */
+export declare const UTILITY_CLASS_ORDER: readonly ["container", "position", "display", "flex", "grid", "width", "height", "margin", "padding", "border", "background", "text", "font", "color", "opacity", "shadow", "transition", "animation"];
+/**
+ * Check if a file should be excluded from class naming detection
+ */
+export declare function shouldExcludeFile(filePath: string): boolean;
+/**
+ * Check if a class name follows BEM convention
+ */
+export declare function isBEMClassName(className: string): boolean;
+/**
+ * Check if a class name is a Tailwind utility class
+ */
+export declare function isTailwindUtilityClass(className: string): boolean;
+/**
+ * Check if a class name follows semantic naming
+ */
+export declare function isSemanticClassName(className: string): boolean;
+/**
+ * Check if a class name follows SMACSS convention
+ */
+export declare function isSMACSClassName(className: string): boolean;
+/**
+ * Validate BEM class name and return issues
+ */
+export declare function validateBEMClassName(className: string): string | null;
+/**
+ * Detect BEM patterns in content
+ */
+export declare function detectBEMPatterns(content: string, file: string): ClassNamingPatternInfo[];
+/**
+ * Detect utility-first (Tailwind) patterns in content
+ */
+export declare function detectUtilityFirstPatterns(content: string, file: string): ClassNamingPatternInfo[];
+/**
+ * Detect CSS Modules patterns in content
+ */
+export declare function detectCSSModulesPatterns(content: string, file: string): ClassNamingPatternInfo[];
+/**
+ * Detect semantic naming patterns in content
+ */
+export declare function detectSemanticPatterns(content: string, file: string): ClassNamingPatternInfo[];
+/**
+ * Detect SMACSS patterns in content
+ */
+export declare function detectSMACSPatterns(content: string, file: string): ClassNamingPatternInfo[];
+/**
+ * Detect invalid BEM patterns
+ */
+export declare function detectInvalidBEMPatterns(content: string, file: string): ClassNamingViolationInfo[];
+/**
+ * Detect mixed naming conventions in a file
+ */
+export declare function detectMixedConventions(patterns: ClassNamingPatternInfo[], file: string): ClassNamingViolationInfo[];
+/**
+ * Suggest a BEM fix for an invalid class name
+ */
+export declare function suggestBEMFix(className: string): string;
+/**
+ * Determine the dominant naming convention
+ */
+export declare function getDominantConvention(patterns: ClassNamingPatternInfo[]): ClassNamingPatternType | null;
+/**
+ * Analyze class naming patterns in a file
+ */
+export declare function analyzeClassNaming(content: string, file: string): ClassNamingAnalysis;
+/**
+ * Detector for CSS class naming conventions
+ *
+ * Identifies class naming patterns (BEM, utility-first, CSS Modules, semantic)
+ * and flags inconsistent naming conventions.
+ *
+ * @requirements 9.5 - THE Styling_Detector SHALL detect CSS class naming conventions (BEM, utility-first)
+ */
+export declare class ClassNamingDetector extends RegexDetector {
+    readonly id = "styling/class-naming";
+    readonly category: "styling";
+    readonly subcategory = "class-naming";
+    readonly name = "Class Naming Detector";
+    readonly description = "Detects CSS class naming conventions (BEM, utility-first, CSS Modules) and flags inconsistent naming";
+    readonly supportedLanguages: Language[];
+    /**
+     * Detect class naming patterns and violations
+     */
+    detect(context: DetectionContext): Promise<DetectionResult>;
+    /**
+     * Create a pattern match for BEM usage
+     */
+    private createBEMPattern;
+    /**
+     * Create a pattern match for utility-first usage
+     */
+    private createUtilityFirstPattern;
+    /**
+     * Create a pattern match for CSS Modules usage
+     */
+    private createCSSModulesPattern;
+    /**
+     * Create a pattern match for semantic naming usage
+     */
+    private createSemanticPattern;
+    /**
+     * Create a pattern match for SMACSS usage
+     */
+    private createSMACSPattern;
+    /**
+     * Create a violation for a class naming issue
+     */
+    private createClassNamingViolation;
+    /**
+     * Get explanation for a violation type
+     */
+    private getExplanationForViolationType;
+    /**
+     * Create a quick fix for a class naming violation
+     */
+    private createQuickFixForViolation;
+    /**
+     * Generate a quick fix for a violation
+     */
+    generateQuickFix(violation: Violation): QuickFix | null;
+}
+/**
+ * Create a new ClassNamingDetector instance
+ */
+export declare function createClassNamingDetector(): ClassNamingDetector;
+//# sourceMappingURL=class-naming.d.ts.map

package/dist/styling/class-naming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-naming.d.ts","sourceRoot":"","sources":["../../src/styling/class-naming.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAgB,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAM9F;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,KAAK,GACL,eAAe,GACf,aAAa,GACb,UAAU,GACV,QAAQ,GACR,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,mBAAmB,GACnB,aAAa,GACb,uBAAuB,GACvB,mBAAmB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,mCAAmC;IACnC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,yBAAyB;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,qCAAqC;IACrC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kCAAkC;IAClC,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IACnC,oCAAoC;IACpC,UAAU,EAAE,wBAAwB,EAAE,CAAC;IACvC,mCAAmC;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,6CAA6C;IAC7C,gBAAgB,EAAE,OAAO,CAAC;IAC1B,oCAAoC;IACpC,cAAc,EAAE,OAAO,CAAC;IACxB,wCAAwC;IACxC,YAAY,EAAE,OAAO,CAAC;IACtB,wCAAwC;IACxC,UAAU,EAAE,OAAO,CAAC;IACpB,6CAA6C;IAC7C,kBAAkB,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAClD,6CAA6C;IAC7C,2BAA2B,EAAE,MAAM,CAAC;CACrC;AAMD;;;GAGG;AACH,eAAO,MAAM,WAAW,QAAsH,CAAC;AAE/I;;GAEG;AACH,eAAO,MAAM,kBAAkB,QAA8G,CAAC;AAE9I;;GAEG;AACH,eAAO,MAAM,oBAAoB,mDAUvB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,yBAAyB,mLAiC5B,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,oBAAoB,mDAMvB,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,wBAAwB,mFAmB3B,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,eAAe,2CAQlB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,cAAc,mCAOjB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,sBAAsB,UAMlC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,wMAmBtB,CAAC;AAMX;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE3D;AA6BD;;GAEG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAGzD;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAQjE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAQ9D;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAQ3D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAsBrE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CA6BzF;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAqClG;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAgChG;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAgC9F;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAgC3F;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,wBAAwB,EAAE,CAsClG;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,sBAAsB,EAAE,EAClC,IAAI,EAAE,MAAM,GACX,wBAAwB,EAAE,CAsE5B;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAcvD;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,sBAAsB,EAAE,GAAG,sBAAsB,GAAG,IAAI,CAqBvG;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAmErF;AAMD;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,QAAQ,CAAC,EAAE,0BAA0B;IACrC,QAAQ,CAAC,QAAQ,EAAG,SAAS,CAAU;IACvC,QAAQ,CAAC,WAAW,kBAAkB;IACtC,QAAQ,CAAC,IAAI,2BAA2B;IACxC,QAAQ,CAAC,WAAW,0GAA0G;IAC9H,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,EAAE,CAAuC;IAE9E;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAoCjE;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAgBxB;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAgBjC;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAgB/B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAgB7B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAqClC;;OAEG;IACH,OAAO,CAAC,8BAA8B;IAetC;;OAEG;IACH,OAAO,CAAC,0BAA0B;IA2BlC;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI;CAgCxD;AAMD;;GAEG;AACH,wBAAgB,yBAAyB,IAAI,mBAAmB,CAE/D"}