CodeAnalyzerGenerator 1.0.0

CodeAnalyzerGenerator

Description

An advanced static analyzer for C# code that uses the Roslyn framework (Microsoft.CodeAnalysis) to perform static code analysis. Designed specifically for local use in debug mode, allowing developers to perform code analysis and test coverage using .NET BuildHost.

Key Features

• ✨ Static code analysis using Microsoft.CodeAnalysis (Roslyn)
• 📊 Code coverage report generation
• 🎨 Interactive console interface with color codes
• 📝 Reports in multiple formats (Console and HTML)
• 🔍 Specific analysis coverage according to configuration
• 🚀 Parallel execution for better performance
• 🧹 Cleanup of compilation artifacts

Prerequisites (optional)

• Coverlet (configured for code coverage)

Installation and Configuration

1. Project Configuration

// En Program.cs o Startup.cs
services.AddLocalSonarAnalizer(options =>
{
    options.UseDebugConsole = true; // Enable the interactive console
});

2. Available Log Levels

The interactive console provides different types of messages with color codes:

• 🟦 Info (White): General information
• 🟩 Success (Green): Successful operations
• 🟨 Warning (Yellow): Warnings
• 🟥 Error (Dark Red): Errors
• 🔴 Critical (Red): Critical errors
• 🟦 Highlight (Cyan): Highlighted information

3. Code Coverage Configuration

The coverlet.runsettings file is required for coverage configuration. You have two options:

1. Automatic: If the file does not exist, it will be generated automatically at runtime.
2. Manual: Create the file in your test project with this structure:

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
  <DataCollectionRunSettings>
    <DataCollectors>
      <DataCollector friendlyName="XPlat code coverage">
        <Configuration>
          <Format>cobertura</Format>
          
          <Include>
              [Application]*CommandHandler*
              [Application]*QueryHandler*
          </Include>
          
          <Exclude>
              [xunit.*]*,
              [Moq]*,
              [FluentResults]*,
              [SharedKernel]*,
              [Domain]*,
              [Web.Api]*,
              [Infrastructure]*
          </Exclude>
          
          <ExcludeByAttribute>ExcludeFromCodeCoverage</ExcludeByAttribute>
          
          <ExcludeByFile>
              **/bin/**/*,
              **/obj/**/*,
              **/TestResults/**/*,
              **/Models/**/*,
              **/DependencyInjection.cs
          </ExcludeByFile>
           
          <IncludeTestAssembly>false</IncludeTestAssembly>
        </Configuration>
      </DataCollector>
    </DataCollectors>
  </DataCollectionRunSettings>
</RunSettings>

4. Cleanup Configuration for Production (Optional)

To prevent unnecessary BuildHost folders from being generated during deployment:

<Target Name="DeleteBuildHostFoldersFromOutput" AfterTargets="AfterBuild" Condition="'$(Configuration)' == 'Release'">
    <Message Text="[RELEASE POST-BUILD] Deleting BuildHost folders from Web.Api output: $(TargetDir)" Importance="high" />
    <RemoveDir Directories="$(TargetDir)BuildHost-net472" />
    <RemoveDir Directories="$(TargetDir)BuildHost-netcore" />
</Target>

Use

Public API

// Basic analysis
await analyzer.Analyze(solutionPath);

// Include test projects in the analysis
await analyzer.Analyze(solutionPath, analyzeRulesTestProjects: true);

// Complete analysis with coverage
await analyzer.Analyze(solutionPath, analyzeRulesTestProjects: true, runTestsAndCalculateCoverage: true);

// Complete analysis with HTML report
await analyzer.Analyze(solutionPath, analyzeRulesTestProjects: true, runTestsAndCalculateCoverage: true, outputHtml: true);

Generated Reports

The tool generates two types of reports:

1. Analysis Report:

   • Problems detected by the static analyzer
   • Severity of problems (using Roslyn's DiagnosticSeverity)
   • Exact location in the code
   • Analysis time

2. Coverage Report:

   • Coverage percentage per project
   • Details of classes with incomplete coverage
   • Uncovered lines
   • Partially covered conditions

Troubleshooting

BuildHost Folders

Problem: BuildHost folders continue to appear Solution:

• Verify that the Target is in the correct .csproj file
• Confirm that the condition matches the release configuration

Coverage Not Reported

Problem: Coverage report is not generated Solution:

• Verify the existence of the runsettings file
• Check that the inclusion patterns match the project structure
• Verify that coverlet.collector is referenced in the test project

Important Notes

• 🔒 Designed for local use in development
• 🛠️ Uses .NET BuildHost and Roslyn for static analysis
• 📊 Reports exclude test assemblies for accurate metrics
• ⚡ Analysis runs in parallel using all available cores
• 🎨 Interactive console improves the development experience

License

This project is licensed under the terms of the MIT license.