Merge pull request #19 from allegro/feature/remove-analyzers-references

Feature/remove analyzers references

README.md

@@ -60,10 +60,7 @@ To configure the SDK, the following properties can be added into `Directory.Buil
 For `C#` only:
 
 - `AllegroDotnetSdkEnableImplicitUsingsAdjustments` (default: true for C#) - add `System.Collections.Immutable` and remove `Microsoft.Extensions.Logging` and `System.Net.Http` implicit usings.
-- `UseAllegroDotnetSdkDefaultAnalyzers` (default: true for C# when no CPM) - reference and configure several external analyzers - StyleCop, AsyncFixer, Meziantou.
-- `AllegroDotnetSdkEnableAsyncFixer` (default: `UseAllegroDotnetSdkDefaultAnalyzers`) - references AsyncFixer package.
-- `AllegroDotnetSdkEnableMeziantou` (default: `UseAllegroDotnetSdkDefaultAnalyzers`) - references Meziantou.Analyzers package.
-- `AllegroDotnetSdkEnableStyleCop` (default: `UseAllegroDotnetSdkDefaultAnalyzers`) - references StyleCop.Analyzers package and a preset `stylecop.json`.
+- `AllegroDotnetSdkEnableStyleCopConfig` (default: true for C#) - references a preset `stylecop.json`.
 
 Configure in `Directory.Build.props` - repo wide:
 
@@ -76,7 +73,7 @@ Configure in `Directory.Build.props` - repo wide:
         <!-- The line below disables nullable reference types -->
         <Nullable>disable</Nullable>
         <!-- The line below disables the StyleCop -->
-        <AllegroDotnetSdkEnableStyleCop>false</AllegroDotnetSdkEnableStyleCop>
+        <AllegroDotnetSdkEnableStyleCopConfig>false</AllegroDotnetSdkEnableStyleCopConfig>
     </PropertyGroup>
 
 </Project>
@@ -95,6 +92,24 @@ Configure in `*.csproj` - project settings:
 </Project>
 ```
 
+## Analyzers
+
+This SDK provides some default configuration (rules severity) for selected analyzers: StyleCop, Meziantou and AsyncFixer. It doesn't actually reference them. Avoiding direct references ensures that developers can seamlessly apply and update analyzers without being tied to specific versions.
+
+To add analyzers, include the following in your `Directory.Build.props` or `Directory.Packages.props` file:
+
+```xml
+<Project>
+    <!-- ... -->
+    <ItemGroup>
+        <GlobalPackageReference Include="AsyncFixer" Version="1.6.0"/>
+        <GlobalPackageReference Include="Meziantou.Analyzer" Version="1.0.758"/>
+        <GlobalPackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435"/>
+    </ItemGroup>
+    <!-- ... -->
+</Project>
+```
+
 ## Editor config
 
 The SDK contains a global analyzer config file containing the default configuration for various analyzers and formatters.

src/Allegro.DotnetSdk/Allegro.DotnetSdk.csproj

@@ -1,8 +1,8 @@
 <Project Sdk="Microsoft.Build.NoTargets">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
-    <PackageVersion>2.1.1</PackageVersion>
+    <TargetFramework>net8.0</TargetFramework>
+    <PackageVersion>2.2.0</PackageVersion>
     <IsPackable>true</IsPackable>
     <DevelopmentDependency>true</DevelopmentDependency>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>

src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.targets

@@ -3,21 +3,14 @@
   <!-- Setup this SDKs defaults -->
   <PropertyGroup>
     <!-- Enable default analyzers if CPM is not used. -->
-    <UseAllegroDotnetSdkDefaultAnalyzers Condition="'$(UseAllegroDotnetSdkDefaultAnalyzers)' == '' And '$(ManagePackageVersionsCentrally)' != 'true'">true</UseAllegroDotnetSdkDefaultAnalyzers>
     <AllegroDotnetSdkEnableStyleCopConfig Condition="'$(AllegroDotnetSdkEnableStyleCopConfig)' == ''">true</AllegroDotnetSdkEnableStyleCopConfig>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(UseAllegroDotnetSdkDefaultAnalyzers)' == 'true'">
-    <AllegroDotnetSdkEnableAsyncFixer Condition="'$(AllegroDotnetSdkEnableAsyncFixer)' == ''">true</AllegroDotnetSdkEnableAsyncFixer>
-    <AllegroDotnetSdkEnableMeziantou Condition="'$(AllegroDotnetSdkEnableMeziantou)' == ''">true</AllegroDotnetSdkEnableMeziantou>
-    <AllegroDotnetSdkEnableStyleCop Condition="'$(AllegroDotnetSdkEnableStyleCop)' == ''">true</AllegroDotnetSdkEnableStyleCop>
-  </PropertyGroup>
-
   <!-- 
     Include stylecop configuration if we include StyleCop analyzer within this Sdk,
     or if it was included externally as GlobalPackageReference when CPM is enabled.
   -->
-  <ItemGroup Condition="'$(AllegroDotnetSdkEnableStyleCopConfig)' == 'true' And ('$(AllegroDotnetSdkEnableStyleCop)' == 'true' Or @(GlobalPackageReference->WithMetadataValue('Identity','StyleCop.Analyzers')->Count()) > 0)">
+  <ItemGroup Condition="'$(AllegroDotnetSdkEnableStyleCopConfig)' == 'true' Or @(GlobalPackageReference->WithMetadataValue('Identity','StyleCop.Analyzers')->Count()) > 0)">
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json" Link="stylecop.json" />
   </ItemGroup>
 
@@ -30,6 +23,4 @@
     <Using Remove="System.Net.Http" />
   </ItemGroup>
 
-  <Import Project="Allegro.NET.Sdk.CSharp.Analyzers.targets" />
-
 </Project>

src/Allegro.DotnetSdk/Sdk/Sdk.props

@@ -10,12 +10,6 @@
       Import our custom targets after Directory.Build.targets is imported
     -->
     <CustomAfterDirectoryBuildTargets>$(CustomAfterDirectoryBuildTargets);$(MSBuildThisFileDirectory)Allegro.NET.Sdk.targets</CustomAfterDirectoryBuildTargets>
-
-    <!--
-      LEGACY: remove after no more projects reference NetCoreVersions property:
-      https://sourcegraph.allegrogroup.com/search?q=context:global+repo:AllegroTechies+%22%28NetCoreVersions%29%22&patternType=standard&sm=1&groupBy=repo
-    -->
-    <NetCoreVersions>net6.0</NetCoreVersions>
   </PropertyGroup>
 
   <Import Project="Allegro.NET.Sdk.props" />