Superdev.Editorconfig
1.0.8-pre
See the version list below for details.
dotnet add package Superdev.Editorconfig --version 1.0.8-pre
NuGet\Install-Package Superdev.Editorconfig -Version 1.0.8-pre
<PackageReference Include="Superdev.Editorconfig" Version="1.0.8-pre" />
paket add Superdev.Editorconfig --version 1.0.8-pre
#r "nuget: Superdev.Editorconfig, 1.0.8-pre"
// Install Superdev.Editorconfig as a Cake Addin #addin nuget:?package=Superdev.Editorconfig&version=1.0.8-pre&prerelease // Install Superdev.Editorconfig as a Cake Tool #tool nuget:?package=Superdev.Editorconfig&version=1.0.8-pre&prerelease
Review
To analyze the style and quality of .NET code, analyzers are used that are configured using the .editorconfig file <br />see Code analysis in .NET <br />see EditorConfig <br />see Configuration files for code analysis rules - .NET
There are several analyzer packages
NetAnalyzers, StyleCop, Roslynator, XUnit Analyzers, and Sonar Analyzer.
Current .editorconfig
Current .editorconfig file configures two analyzer packages: <br />Microsoft.CodeAnalysis.CSharp.CodeStyle - Code-style rules overview - .NET <br />StyleCop.Analyzers - StyleCopAnalyzers Status
How to include .editorconfig
You will need to install the appropriate version of the Superdev.Editorconfig nuget package into your project and all the following magic should appear by itself after the first build. <hr /> The .editorconfig file must be placed at the root of the solution/project. <br />Microsoft.CodeAnalysis.CSharp.CodeStyle - will work automatically in popular IDEs (Visual Studio, Visual Studio Code, Rider (partial)) <br />StyleCop.Analyzers - for this package to work, you need to include the NuGet package StyleCop.Analyzers in solution
The .editorconfig supported by Visual Studio, Visual Studio Code, Rider (partially) and other IDEs (if it supports .editorconfig settings) <br /><span style="color:green">Note:</span> IDEs may introduce their own additional rules, but .editorconfig has the highest priority. <br /><span style="color:red">Attention:</span> .editorconfig will only work at the IDE level. See below for how the analyzers work during build.
Running analyzes at build time
The .editorconfig file must be placed at the root of the solution/project.
Add NuGet packages to your projects: <br />Microsoft.CodeAnalysis.CSharp.CodeStyle <br />StyleCop.Analyzers
After that, the projects will be built taking into account the analyzers and issue errors and warnings according to the analyzers settings.
Run in CI/CD
If NuGet packages are included in the project, the analyzers described above will be launched when the project is built <br /><span style="color:green">Note:</span> if the NuGet packages described above are not included in the project being built, they can be installed during the build, and then the build will be carried out with the analyzers. This way we can force the analyzers to run and issue build errors.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard1.6 is compatible. netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen30 was computed. tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 1.6
- NETStandard.Library (>= 1.6.1)
-
.NETStandard 2.0
- No dependencies.
-
.NETStandard 2.1
- No dependencies.
-
net5.0
- No dependencies.
-
net6.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.27-pre | 173 | 7/26/2023 |
1.0.26-pre | 160 | 7/26/2023 |
1.0.25-pre | 167 | 7/25/2023 |
1.0.24 | 224 | 6/6/2023 |
1.0.22-pre | 150 | 6/6/2023 |
1.0.21-pre | 147 | 6/6/2023 |
1.0.20-pre | 145 | 6/5/2023 |
1.0.19 | 193 | 4/26/2023 |
1.0.17-pre | 162 | 4/25/2023 |
1.0.14 | 893 | 9/7/2022 |
1.0.13-pre | 173 | 9/7/2022 |
1.0.12-pre | 159 | 9/7/2022 |
1.0.11 | 427 | 9/6/2022 |
1.0.9-pre | 180 | 9/6/2022 |
1.0.8-pre | 165 | 9/6/2022 |
1.0.7-pre | 161 | 9/6/2022 |
1.0.6 | 422 | 9/6/2022 |
1.0.0
- Initial release