Implemented settings part

Author: vweijsters

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/LayoutRules/SA1518CodeFixProvider.cs

@@ -53,13 +53,13 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context)
         /// </summary>
         /// <param name="document">The document to be changed.</param>
         /// <param name="diagnostic">The diagnostic to fix.</param>
-        /// <param name="newlineAtEndOfFile">A <see cref="EndOfFileHandling"/> value indicating the desired behavior.</param>
+        /// <param name="newlineAtEndOfFile">A <see cref="OptionSetting"/> value indicating the desired behavior.</param>
         /// <param name="cancellationToken">The cancellation token associated with the fix action.</param>
         /// <returns>The transformed document.</returns>
-        private static async Task<Document> FixEndOfFileAsync(Document document, Diagnostic diagnostic, EndOfFileHandling newlineAtEndOfFile, CancellationToken cancellationToken)
+        private static async Task<Document> FixEndOfFileAsync(Document document, Diagnostic diagnostic, OptionSetting newlineAtEndOfFile, CancellationToken cancellationToken)
         {
             var text = await document.GetTextAsync(cancellationToken).ConfigureAwait(false);
-            string replacement = newlineAtEndOfFile == EndOfFileHandling.Omit ? string.Empty : "\r\n";
+            string replacement = newlineAtEndOfFile == OptionSetting.Omit ? string.Empty : "\r\n";
             return document.WithText(text.WithChanges(new TextChange(diagnostic.Location.SourceSpan, replacement)));
         }
 

StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1518UnitTests.cs

@@ -31,9 +31,10 @@ public void VerifySettingsDefaults()
 
             Assert.NotNull(styleCopSettings.OrderingRules);
             Assert.Equal(UsingDirectivesPlacement.InsideNamespace, styleCopSettings.OrderingRules.UsingDirectivesPlacement);
+            Assert.Equal(OptionSetting.Allow, styleCopSettings.OrderingRules.UseBlankLinesBetweenUsingGroups);
 
             Assert.NotNull(styleCopSettings.LayoutRules);
-            Assert.Equal(EndOfFileHandling.Allow, styleCopSettings.LayoutRules.NewlineAtEndOfFile);
+            Assert.Equal(OptionSetting.Allow, styleCopSettings.LayoutRules.NewlineAtEndOfFile);
 
             Assert.NotNull(styleCopSettings.SpacingRules);
             Assert.NotNull(styleCopSettings.ReadabilityRules);
@@ -58,8 +59,12 @@ public async Task VerifySettingsAreReadCorrectlyAsync()
         ""allowCommonHungarianPrefixes"": false,
         ""allowedHungarianPrefixes"": [""a"", ""ab""]
     },
+    ""layoutRules"": {
+        ""newlineAtEndOfFile"": ""require""
+    },
     ""orderingRules"": {
-        ""usingDirectivesPlacement"": ""outsideNamespace""
+        ""usingDirectivesPlacement"": ""outsideNamespace"",
+        ""useBlankLinesBetweenUsingGroups"": ""omit"",
     }
   }
 }
@@ -73,8 +78,12 @@ public async Task VerifySettingsAreReadCorrectlyAsync()
             Assert.False(styleCopSettings.NamingRules.AllowCommonHungarianPrefixes);
             Assert.Equal(new[] { "a", "ab" }, styleCopSettings.NamingRules.AllowedHungarianPrefixes);
 
+            Assert.NotNull(styleCopSettings.LayoutRules);
+            Assert.Equal(OptionSetting.Require, styleCopSettings.LayoutRules.NewlineAtEndOfFile);
+
             Assert.NotNull(styleCopSettings.OrderingRules);
             Assert.Equal(UsingDirectivesPlacement.OutsideNamespace, styleCopSettings.OrderingRules.UsingDirectivesPlacement);
+            Assert.Equal(OptionSetting.Omit, styleCopSettings.OrderingRules.UseBlankLinesBetweenUsingGroups);
         }
 
         /// <summary>

StyleCop.Analyzers/StyleCop.Analyzers.Test/Settings/SettingsUnitTests.cs

@@ -144,7 +144,7 @@ private static void HandleSyntaxTree(SyntaxTreeAnalysisContext context, StyleCop
             DiagnosticDescriptor descriptorToReport;
             switch (settings.LayoutRules.NewlineAtEndOfFile)
             {
-            case EndOfFileHandling.Omit:
+            case OptionSetting.Omit:
                 if (firstNewline < 0)
                 {
                     return;
@@ -153,7 +153,7 @@ private static void HandleSyntaxTree(SyntaxTreeAnalysisContext context, StyleCop
                 descriptorToReport = DescriptorOmit;
                 break;
 
-            case EndOfFileHandling.Require:
+            case OptionSetting.Require:
                 if (firstNewline >= 0 && firstNewline == trailingWhitespaceText.Length - 1)
                 {
                     return;
@@ -162,7 +162,7 @@ private static void HandleSyntaxTree(SyntaxTreeAnalysisContext context, StyleCop
                 descriptorToReport = DescriptorRequire;
                 break;
 
-            case EndOfFileHandling.Allow:
+            case OptionSetting.Allow:
             default:
                 if (secondNewline < 0)
                 {

StyleCop.Analyzers/StyleCop.Analyzers/LayoutRules/SA1518UseLineEndingsCorrectlyAtEndOfFile.cs

@@ -12,18 +12,18 @@ internal class LayoutSettings
         /// This is the backing field for the <see cref="NewlineAtEndOfFile"/> property.
         /// </summary>
         [JsonProperty("newlineAtEndOfFile", DefaultValueHandling = DefaultValueHandling.Include)]
-        private EndOfFileHandling newlineAtEndOfFile;
+        private OptionSetting newlineAtEndOfFile;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="LayoutSettings"/> class during JSON deserialization.
         /// </summary>
         [JsonConstructor]
         protected internal LayoutSettings()
         {
-            this.newlineAtEndOfFile = EndOfFileHandling.Allow;
+            this.newlineAtEndOfFile = OptionSetting.Allow;
         }
 
-        public EndOfFileHandling NewlineAtEndOfFile =>
+        public OptionSetting NewlineAtEndOfFile =>
             this.newlineAtEndOfFile;
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/LayoutSettings.cs

@@ -4,22 +4,22 @@
 namespace StyleCop.Analyzers.Settings.ObjectModel
 {
     /// <summary>
-    /// Specifies the handling for newline characters which appear at the end of a file.
+    /// Specifies the possible values for an option.
     /// </summary>
-    internal enum EndOfFileHandling
+    internal enum OptionSetting
     {
         /// <summary>
-        /// Files are allowed to end with a single newline character, but it is not required.
+        /// The option is allowed, but not required.
         /// </summary>
         Allow,
 
         /// <summary>
-        /// Files are required to end with a single newline character.
+        /// The option is required.
         /// </summary>
         Require,
 
         /// <summary>
-        /// Files may not end with a newline character.
+        /// The option is not allowed.
         /// </summary>
         Omit
     }

…ettings/ObjectModel/EndOfFileHandling.cs …rs/Settings/ObjectModel/OptionSetting.csStyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/EndOfFileHandling.cs renamed to StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/OptionSetting.cs StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/EndOfFileHandling.cs renamed to StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/OptionSetting.cs

@@ -35,6 +35,12 @@ internal class OrderingSettings
         [JsonProperty("usingDirectivesPlacement", DefaultValueHandling = DefaultValueHandling.Include)]
         private UsingDirectivesPlacement usingDirectivesPlacement;
 
+        /// <summary>
+        /// This is the backing field for the <see cref="UseBlankLinesBetweenUsingGroups"/> property.
+        /// </summary>
+        [JsonProperty("useBlankLinesBetweenUsingGroups", DefaultValueHandling = DefaultValueHandling.Include)]
+        private OptionSetting useBlankLinesBetweenUsingGroups;
+
         /// <summary>
         /// Initializes a new instance of the <see cref="OrderingSettings"/> class during JSON deserialization.
         /// </summary>
@@ -44,6 +50,7 @@ protected internal OrderingSettings()
             this.elementOrder = ImmutableArray.CreateBuilder<OrderingTrait>();
             this.systemUsingDirectivesFirst = true;
             this.usingDirectivesPlacement = UsingDirectivesPlacement.InsideNamespace;
+            this.useBlankLinesBetweenUsingGroups = OptionSetting.Allow;
         }
 
         public ImmutableArray<OrderingTrait> ElementOrder
@@ -59,5 +66,8 @@ public ImmutableArray<OrderingTrait> ElementOrder
 
         public UsingDirectivesPlacement UsingDirectivesPlacement =>
             this.usingDirectivesPlacement;
+
+        public OptionSetting UseBlankLinesBetweenUsingGroups =>
+            this.useBlankLinesBetweenUsingGroups;
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/OrderingSettings.cs

@@ -90,6 +90,16 @@
                 "preserve"
               ],
               "default": "insideNamespace"
+            },
+            "useBlankLinesBetweenUsingGroups": {
+              "type": "string",
+              "description": "Specifies if using groups should be separated by a blank line.\r\nallow: A blank line is allowed, but not required\r\nrequire: A blank line is required\r\nomit: A blank line is not allowed",
+              "enum": [
+                "allow",
+                "require",
+                "omit"
+              ],
+              "default": "allow"
             }
           }
         },

StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json

@@ -269,7 +269,7 @@
     <Compile Include="ReadabilityRules\SX1101DoNotPrefixLocalMembersWithThis.cs" />
     <Compile Include="Settings\DeserializationFailureBehavior.cs" />
     <Compile Include="Settings\ObjectModel\DocumentationSettings.cs" />
-    <Compile Include="Settings\ObjectModel\EndOfFileHandling.cs" />
+    <Compile Include="Settings\ObjectModel\OptionSetting.cs" />
     <Compile Include="Settings\ObjectModel\FileNamingConvention.cs" />
     <Compile Include="Settings\ObjectModel\IndentationSettings.cs" />
     <Compile Include="Settings\ObjectModel\LayoutSettings.cs" />