How mehdiway/codequalityenforcer works
Key Components to Include:
Main System Components
• Roslyn Analyzer Integration
• Rule Enforcement Engine
• Build Process Integration
• Project Configuration
Component Relationships
A. Core Components (Top Level):
Inside this container, create these primary components
a) Analyzer Engine (Central):
• It as a hexagon to indicate it's the core processing unit
b) Rule Processors (Right side):
• Create two connected modules:
• "Nullable Reference Type Enforcer"
• "Method Complexity Analyzer"
• Use rectangles for these components
c) Build Integration (Left side):
• A component for ".NET Build Pipeline Integration"
• Connection to MSBuild using the props file
Source Code Input
• Direction: External → Analyzer Engine
Output Flow
• Use red for errors, yellow for warnings
C. Integration Points:
"Roslyn Compiler Integration"
• How it interfaces with the analyzer engine
• It's part of the compilation process
D. Special Considerations:
Version compatibility
• ".NET Core 3.1+ / .NET 5+"
• "C# 8.0+" requirement
E. Technical Details to Include:
Zero-dependency nature
• "No Runtime Dependencies" in a note
Rule Configuration
• A small component showing the complexity limit of 15
• Nullable reference type settings
Callouts explaining
• How the analyzer integrates with the build process
• The error generation mechanism
• Rule enforcement strategy