Clean up RuleOrdering

Previously rule orderings were split across all the different
rules. With this change, I have introduced a new RuleOrder static
class that has constants for each rule sorted by the order in which
they run.  This will make it easier to see the ordering of rules and
make additions of new rules easier to review.

Perhaps longer term we'll want to move to a system where rules declare
dependencies or something and we build an ordering based on them, but
for now I think this is better than the existing pattern.

Author: ellismg

src/Microsoft.DotNet.CodeFormatting/Microsoft.DotNet.CodeFormatting.csproj

@@ -101,6 +101,7 @@
     <Compile Include="Rules\IsSimplifiedFormattingRule.cs" />
     <Compile Include="Rules\NonAsciiCharactersAreEscapedInLiteralsRule.cs" />
     <Compile Include="Rules\RuleExtensions.cs" />
+    <Compile Include="Rules\RuleOrder.cs" />
     <Compile Include="Rules\UsesXunitForTestsFormattingRule.cs" />
     <Compile Include="RuleTypeConstants.cs" />
   </ItemGroup>

src/Microsoft.DotNet.CodeFormatting/Rules/ExplicitVisibilityRule.cs

@@ -14,7 +14,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(9)]
+    [RuleOrder(RuleOrder.ExplicitVisibilityRule)]
     internal sealed class ExplicitVisibilityRule : IFormattingRule
     {
         private sealed class VisibilityRewriter : CSharpSyntaxRewriter

src/Microsoft.DotNet.CodeFormatting/Rules/HasCopyrightHeaderFormattingRule.cs

@@ -13,7 +13,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(3)]
+    [RuleOrder(RuleOrder.HasCopyrightHeaderFormattingRule)]
     internal sealed class HasCopyrightHeaderFormattingRule : IFormattingRule
     {
         private static readonly string[] s_copyrightHeader =

src/Microsoft.DotNet.CodeFormatting/Rules/HasNewLineBeforeFirstNamespaceFormattingRule.cs

@@ -14,7 +14,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(6)]
+    [RuleOrder(RuleOrder.HasNewLineBeforeFirstNamespaceFormattingRule)]
     internal sealed class HasNewLineBeforeFirstNamespaceFormattingRule : IFormattingRule
     {
         public async Task<Document> ProcessAsync(Document document, CancellationToken cancellationToken)

src/Microsoft.DotNet.CodeFormatting/Rules/HasNewLineBeforeFirstUsingFormattingRule.cs

@@ -15,7 +15,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(5)]
+    [RuleOrder(RuleOrder.HasNewLineBeforeFirstUsingFormattingRule)]
     internal sealed class HasNewLineBeforeFirstUsingFormattingRule : IFormattingRule
     {
         private const string FormatError = "Could not format using";

src/Microsoft.DotNet.CodeFormatting/Rules/HasNoCustomCopyrightHeaderFormattingRule.cs

@@ -15,7 +15,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(1)]
+    [RuleOrder(RuleOrder.HasNoCustomCopyrightHeaderFormattingRule)]
     internal sealed class HasNoCustomCopyrightHeaderFormattingRule : IFormattingRule
     {
         private static string RulerMarker { get; set; }

src/Microsoft.DotNet.CodeFormatting/Rules/HasNoIllegalHeadersFormattingRule.cs

@@ -15,7 +15,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(2)]
+    [RuleOrder(RuleOrder.HasNoIllegalHeadersFormattingRule)]
     internal sealed class HasNoIllegalHeadersFormattingRule : IFormattingRule
     {
         // We are going to replace this header with the actual filename of the document being processed

src/Microsoft.DotNet.CodeFormatting/Rules/HasNoNewLineAfterOpenBraceFormattingRule.cs

@@ -13,7 +13,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(8)]
+    [RuleOrder(RuleOrder.HasNoNewLineAfterOpenBraceFormattingRule)]
     internal sealed class HasNoNewLineAfterOpenBraceFormattingRule : IFormattingRule
     {
         public async Task<Document> ProcessAsync(Document document, CancellationToken cancellationToken)

src/Microsoft.DotNet.CodeFormatting/Rules/HasNoNewLineBeforeEndBraceFormattingRule.cs

@@ -13,7 +13,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(7)]
+    [RuleOrder(RuleOrder.HasNoNewLineBeforeEndBraceFormattingRule)]
     internal sealed class HasNoNewLineBeforeEndBraceFormattingRule : IFormattingRule
     {
         public async Task<Document> ProcessAsync(Document document, CancellationToken cancellationToken)

src/Microsoft.DotNet.CodeFormatting/Rules/HasUnderScoreInPrivateFieldNamesFormattingRule.cs

@@ -17,7 +17,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [RuleOrder(10)]
+    [RuleOrder(RuleOrder.HasUnderScoreInPrivateFieldNamesFormattingRule)]
     // TODO Bug 1086632: Deactivated due to active bug in Roslyn.
     // There is a hack to run this rule, but it's slow. 
     // If needed, enable the rule and enable the hack at the code below in RenameFields.