How to configure rules like S138: Functions should not have too many lines of code in .editorconfig?

wertzui · October 29, 2020, 11:04am

I’m using SonarAnalyzer.Csharp as a Nuget Package and I want to configure the rules that should apply to my team through an .editorconfig file.
It is easy to set the severity of the rules, but how can I change parameters, like the lines of code for S138?

costin.zaharia · December 7, 2020, 3:13pm

Hi @wertzui,

this can be customized in SonarQube/SonarCloud but .editorconfig is not supported for now. We are considering doing this but, as of now, it is only an idea.

If using SonarQube is not possible you could try to use SonarLint.xml for configuring this:

github.com

SonarSource/sonar-dotnet/blob/master/analyzers/.sonarlint/sonaranalyzer-dotnet/CSharp/SonarLint.xml

<?xml version="1.0" encoding="utf-8"?>
<AnalysisInput xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Settings>
    <Setting>
      <Key>sonar.cs.analyzeGeneratedCode</Key>
      <Value>false</Value>
    </Setting>
    <Setting>
      <Key>sonar.cs.file.suffixes</Key>
      <Value>.cs</Value>
    </Setting>
    <Setting>
      <Key>sonar.cs.ignoreHeaderComments</Key>
      <Value>true</Value>
    </Setting>
    <Setting>
      <Key>sonar.cs.roslyn.ignoreIssues</Key>
      <Value>false</Value>
    </Setting>
  </Settings>

This file has been truncated. show original

github.com

SonarSource/sonar-dotnet/blob/master/analyzers/src/SonarAnalyzer.CFG/SonarAnalyzer.CFG.csproj#L44


    This PropertyGroup is used as a hack to prevent the NU1605 issue to be reported as an error. The rule is detecting
    the downgrade of System.Collections.Immutable from 1.2.0 to 1.1.37 (VS 2015 Update 3 only embeds 1.1.37).
    Do not use NoWarn in order to avoid hiding other issues.
  -->
  <PropertyGroup>
    <WarningsAsErrors />
    <NoWarn>NU1605</NoWarn>
  </PropertyGroup>
  <ItemGroup>
    <AdditionalFiles Include="..\..\.sonarlint\sonaranalyzer-dotnet\CSharp\SonarLint.xml" Link="Properties\SonarLint.xml" />
  </ItemGroup>
  <Target Name="SignDlls" Condition="'$(SignAssembly)' == 'true' and $(TargetFramework) != ''" AfterTargets="Build">
    <Message Importance="high" Text="Signing SonarAnalyzer.CFG assemblies from $(OutDir)" />
    <Exec WorkingDirectory="$(OutDir)" Command="&quot;$(SIGNTOOL_PATH)&quot; sign /fd SHA256 /f $(PFX_PATH) /p $(PFX_PASSWORD) /tr http://sha256timestamp.ws.symantec.com/sha256/timestamp SonarAnalyzer.CFG.dll" />
  </Target>
  <Import Project="..\..\StyleCopAnalyzers.targets" />
</Project>

system · December 14, 2020, 3:13pm

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Does sonaranalyzer.csharp nuget package supports configuration through .editorconfig instead of SonarLint.xml? Visual Studio csharp , visualstudio	2	1704	April 23, 2021
Import ".editorconfig" rules from Visual Studio to SonarQube SonarQube Server / Community Build csharp , visualstudio , dotnet , rules	3	2144	August 19, 2022
.editorconfig is not being recognized by SonarQube Visual Studio sonarqube , visualstudio , sonarqube-ide	2	3855	February 27, 2020
Sonar rules are missing in editorconfig in extension mode Visual Studio	1	591	November 22, 2023
Can Sonarlint's Use the EditorConfig File in VS2019? Visual Studio visualstudio , sonarqube-ide	3	3139	June 23, 2021

How to configure rules like S138: Functions should not have too many lines of code in .editorconfig?

Related topics