CSharp-LocalSonarAnalizer 1.0.2

CSharp-LocalSonarAnalyzer

Advanced static code analyzer for C# that uses SonarAnalyzer.CSharp and SonarQube rules. Designed for local use in debug mode only.

Features

• Static code analysis using SonarQube rules
• Local debugging capabilities
• Code coverage reporting
• Build artifact cleanup for production deployments

Prerequisites

• .NET SDK (version X.X or higher)
• SonarAnalyzer.CSharp package
• Coverlet for code coverage (already configured)

Configuration

Code Coverage Setup

1. Create a coverlet.runsettings file in your Application.Test project
2. Add the following configuration:

<?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>

Production Deployment Cleanup (Optional)

To prevent generation of unnecessary BuildHost folders during deployment, add this to your startup project's .csproj file:

��� <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> ���

Usage

1. Configure the coverlet.runsettings as shown above
2. Build the solution in Debug mode
3. Run the analyzer against your target project
4. Review analysis results in your IDE or output window

Troubleshooting

• BuildHost folders still appearing: Ensure the Target is added to the correct project file and the Condition matches your release configuration
• Coverage not reported: Verify the runsettings file is in the correct location and includes match your project structure

Notes

• This analyzer is intended for local development use only
• For production analysis, consider using a full SonarQube server installation
• Remember to exclude test assemblies from coverage reports for accurate metrics