Class StyleConventionDetector

Detects and quantifies style conventions of a codebase: RxJS patterns, DI style, state management, naming conventions and architecture.

Index

Constructors

Methods

alignsWithStyle detectStyles

Constructors

constructor

new StyleConventionDetector(
config?: Partial<StyleDetectionConfig>,
): StyleConventionDetector
Parameters
- Optionalconfig: Partial<StyleDetectionConfig>
Returns StyleConventionDetector

Methods

alignsWithStyle

alignsWithStyle(
patternType: string,
styleProfile: StyleProfile,
): { alignment: number; aligns: boolean; reason: string }
Check if a pattern aligns with the style profile
Parameters
- patternType: string
- styleProfile: StyleProfile
Returns { alignment: number; aligns: boolean; reason: string }
- alignment: number
  Alignment score (0-1).
- aligns: boolean
  Whether the pattern fits the codebase style.
- reason: string
  Explanation, usually with the measured share.

detectStyles

detectStyles(project: Project): StyleDetectionResult
Analyze a project and detect style conventions
Parameters
- project: Project
Returns StyleDetectionResult