The problem In our organization, we are running multiple GitHub repositories with different web services. All these projects require common rules for code styling. We moved the right way and created a service template project which is a basis for all the .NET solutions and defines a common architecture. It contains a set of projects with correct naming and references. However, we moved the wrong way and copied the file to every new repository. There was a temptation to modify the file whenever it does not fit the developer’s needs. And we did this fault. .editorconfig .editorconfig There is not much information on the Internet on how to create a common file and distribute it across multiple repositories. The god feeling told that it must be a NuGet package. After a long time of googling the problem, we found solution. Thanks to who solved the same issue for his project. .editorconfig this Adam Craven Why EditorConfig EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. The EditorConfig project consists of for defining coding styles and a collection of that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems. a file format text editor plugins In the .NET world, code analysis rules have various configuration options. You specify these options as key-value pairs in one of the following analyzer configuration files: file: File-based or folder-based configuration options. EditorConfig file: Project-level configuration options. Useful when some project files reside outside the project folder. Global AnalyzerConfig You can set the severity for compiler warnings or analyzer rules in an EditorConfig file with the following syntax: dotnet_diagnostic.<rule ID>.severity = <severity> Setting a rule's in an EditorConfig file takes precedence over any severity that's set in a rule set or in Solution Explorer. severity In some projects, there is a mix of local and global config files. Moreover, EditorConfg has some limitations in the .NET world also specified in this article in the section. We tried both ways and moved back and forth with these two approaches. And finally decided to move a simple way to use just EditoConfig for our projects. limitations The solution First things first, you need to create a new C# library project for the NuGet package. Let’s call it . This project will contain the following files: MyProject.EditorConfig file .props file .csproj file .editorconfig .props file You have to add PropertyGroup with the following properties set to the true value: <PropertyGroup> <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild> <EnableNETAnalyzers>true</EnableNETAnalyzers> </PropertyGroup> - allows specified in the EditorConfig file to be checked as part of the build; EnforceCodeStyleInBuild code style rules is , but rather set it to true to support earlier versions of .NET; EnableNETAnalyzers true by default for .NET 5.0 As one of the limitations of EditorConfig is that some rules have and cannot be specified in an EditorConfig file. If you do not use the Global AnalyzerConfig file as we do, you would have an option to disable those rules in the file: Location.None .props <PropertyGroup> <NoWarn>$(NoWarn);CA1014</NoWarn> </PropertyGroup> Specify the location of the file to copy from within the NuGet package folder structure: .editorconfig <ItemGroup> <EditorConfigFilesToCopy Include="$(MSBuildThisFileDirectory)../content/Rules/.editorconfig" /> </ItemGroup> Be careful with and symbols in the file path string on different platforms. It really took us much time to figure out why file is not copied. \ / .editorconfig Use the MSBuild Task to copy the file to the folder of the .NET Project that is being built. This Target is defined to execute before the MSBuild Target. Copy BeforeBuild <Target Name="CopyEditorConfig" BeforeTargets="BeforeBuild"> <Message Text="Copying the .editorconfig file from '@(EditorConfigFilesToCopy)' to '$(SolutionFolder)'"></Message> <Copy SourceFiles="@(EditorConfigFilesToCopy)" DestinationFolder="$(SolutionFolder)" SkipUnchangedFiles="true" UseHardlinksIfPossible="false" /> </Target> .csproj file By default, when packing NuGet files that start with a period are ignored. To avoid that you have to add the following code to the file: .csproj <PropertyGroup> <NoDefaultExcludes>true</NoDefaultExcludes> </PropertyGroup> After that you have to include and files: .props .editorconfig <ItemGroup> <None Include="MyProject.EditorConfig.props" Pack="true" PackagePath="\build" /> <None Include=".editorconfig" Pack="true" PackagePath="\content\Rules" /> </ItemGroup> Build and test NuGet package When the all job is done you can publish NuGet package to the local storage and verify that it works. Execute the following command in the project folder to pack a NuGet package: MyProject.EditorConfig dotnet pack MyProject.EditorConfig.csproj -c Release -o out --no-restore Publish it into local storage (folder). hast to be installed beforehand: NuGet CLI nuget add out/MyProject.EditorConfig.1.0.0.nupkg -Source /Users/igorlopushko/test_nuget_expand/ -Expand Specify a target folder with parameter. -Source Register local NuGet package path: dotnet nuget add source /Users/igorlopushko/test_nuget_expand/ To add a local NuGet package to the target project execute this command in the target project’s folder: dotnet add package MyProject.EditorConfig -s /Users/igorlopushko/test_nuget_expand/ When you build your target project you will get the file in the root directory of this project. It will be overwritten every time you build a project. Even if it was modified somehow by mistake the file will be overwritten on the build. .editorconfig .editorconfig Conclusion The solution is quite simple, but it made our team's life easier. We have added this NuGet package to all our projects and avoid desynchronization in code styles across all the repositories.
