Update .editorconfig and rulesets based on feedback

[originalfoo]

Dymanoid mentioned following in PR #16:

• The .NET naming convention suggests using PascalCase for constants.
• The .NET naming convention suggests either PascalCase or camelCase for static fields. The underscore should be used as a prefix for _instanceFields.

These things should be configured in the .editorconfig and/or ruleset.

[dymanoid]

You can just use StyleCop.Analyzers. These rules are activated there by default, including the BSD-style of the braces and many more.

You will also have the Quick Fixes for those rules, so you can automagically fix all code style violations in the whole solution by one mouse click.

[originalfoo]

My plan is to have a separate git repo for the ruleset and the .editorconfig and then include that in to all the others, that way any changes can be rolled out to all repos.

Currently no idea how to do that or even if it will work heh.

[dymanoid]

Currently, there is no built-in way to share .editorconfig and stuff across repositories. However, there are open issues in the C# Roslyn compiler repo here, on GitHub. It is currently in state "needs design" (see dotnet/roslyn#19028).

There are some attempts to create workarounds, but I doubt the effort is worth it, and these workarounds heavily depend on the client usage.

[leonardochaia]

My plan is to have a separate git repo for the ruleset and the .editorconfig and then include that in to all the others, that way any changes can be rolled out to all repos.

Hi @aubergine10 , did you figure this out? I'm trying to figure out the best way to distribute .editorconfig files organization wide.

Thank you.

[originalfoo]

No, not yet. Currently I manually just copy the file between existing repos.

[leonardochaia]

So, nothing is perfect but this is how I've done it and it works..

For anyone who's wondering..
You need a .nuspec file:

<?xml version="1.0"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
  <metadata>
    [..]
   <id>YourPackageId</id>
    <developmentDependency>true</developmentDependency>
    <dependencies>
      <dependency id="StyleCop.Analyzers" version="1.1.118" />
      <dependency id="SonarAnalyzer.CSharp" version="8.8.0.18411" />
    </dependencies>
  </metadata>
  <files>
    <file src="../../stylecop.json" target="build/stylecop.json" />
    <file src="../../.editorconfig" target="build/.editorconfig" />

    <file src="YourPackageId.targets" target="build/" />
  </files>
</package>

In the .targets file, copy the files next to the .sln file, which I assume is at the root of the project or at least on a higher directory of the .csproj files.

<Project>
  <!--
  Copies the files to next to the solution file, which should be
  in the root of the project
  -->
  <Target Name="CopyPackage" AfterTargets="PrepareForBuild">
    <Copy
      SourceFiles="$(MSBuildThisFileDirectory)\.editorconfig"
      DestinationFolder="$(SolutionDir)"
    />
    <Copy
      SourceFiles="$(MSBuildThisFileDirectory)\stylecop.json"
      DestinationFolder="$(SolutionDir)"
    />
  </Target>

  <!-- It is needed for stylecop to work -->
  <ItemGroup>
    <AdditionalFiles Include="$(SolutionDir)\stylecop.json" />
  </ItemGroup>
</Project>

I have a .csproj for this but you can just use nuget.exe and the nuspec

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.1</TargetFramework>
    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
    <NuspecFile>.nuspec</NuspecFile>
    <NoDefaultExcludes>true</NoDefaultExcludes>
  </PropertyGroup>
</Project>

If you're wondering if you can use only the .csproj instead of the nuspec, I tried and run into many issues, if you figure it out do let me know.