Add the usingDirectivesPlacement configuration property

Author: sharwell

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

@@ -6,6 +6,7 @@ namespace StyleCop.Analyzers.Test.Settings
     using System.Collections.Immutable;
     using System.Threading;
     using System.Threading.Tasks;
+    using Analyzers.Settings.ObjectModel;
     using Microsoft.CodeAnalysis;
     using Microsoft.CodeAnalysis.Diagnostics;
     using Microsoft.CodeAnalysis.Text;
@@ -28,9 +29,11 @@ public void VerifySettingsDefaults()
             Assert.True(styleCopSettings.NamingRules.AllowCommonHungarianPrefixes);
             Assert.Equal(0, styleCopSettings.NamingRules.AllowedHungarianPrefixes.Length);
 
+            Assert.NotNull(styleCopSettings.OrderingRules);
+            Assert.Equal(UsingDirectivesPlacement.InsideNamespace, styleCopSettings.OrderingRules.UsingDirectivesPlacement);
+
             Assert.NotNull(styleCopSettings.SpacingRules);
             Assert.NotNull(styleCopSettings.ReadabilityRules);
-            Assert.NotNull(styleCopSettings.OrderingRules);
             Assert.NotNull(styleCopSettings.MaintainabilityRules);
         }
 
@@ -51,6 +54,9 @@ public async Task VerifySettingsAreReadCorrectlyAsync()
     ""namingRules"": {
         ""allowCommonHungarianPrefixes"": false,
         ""allowedHungarianPrefixes"": [""a"", ""ab""]
+    },
+    ""orderingRules"": {
+        ""usingDirectivesPlacement"": ""outsideNamespace""
     }
   }
 }
@@ -63,6 +69,9 @@ public async Task VerifySettingsAreReadCorrectlyAsync()
             Assert.Equal("Custom copyright text.", styleCopSettings.DocumentationRules.CopyrightText);
             Assert.False(styleCopSettings.NamingRules.AllowCommonHungarianPrefixes);
             Assert.Equal(new[] { "a", "ab" }, styleCopSettings.NamingRules.AllowedHungarianPrefixes);
+
+            Assert.NotNull(styleCopSettings.OrderingRules);
+            Assert.Equal(UsingDirectivesPlacement.OutsideNamespace, styleCopSettings.OrderingRules.UsingDirectivesPlacement);
         }
 
         /// <summary>

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

@@ -8,12 +8,22 @@ namespace StyleCop.Analyzers.Settings.ObjectModel
     [JsonObject(MemberSerialization.OptIn)]
     internal class OrderingSettings
     {
+        /// <summary>
+        /// This is the backing field for the <see cref="UsingDirectivesPlacement"/> property.
+        /// </summary>
+        [JsonProperty("usingDirectivesPlacement", DefaultValueHandling = DefaultValueHandling.Include)]
+        private UsingDirectivesPlacement usingDirectivesPlacement;
+
         /// <summary>
         /// Initializes a new instance of the <see cref="OrderingSettings"/> class during JSON deserialization.
         /// </summary>
         [JsonConstructor]
         protected internal OrderingSettings()
         {
+            this.usingDirectivesPlacement = UsingDirectivesPlacement.InsideNamespace;
         }
+
+        public UsingDirectivesPlacement UsingDirectivesPlacement =>
+            this.usingDirectivesPlacement;
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/UsingDirectivesPlacement.cs

@@ -0,0 +1,26 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Settings.ObjectModel
+{
+    /// <summary>
+    /// Specifies the desired placement of using directives.
+    /// </summary>
+    internal enum UsingDirectivesPlacement
+    {
+        /// <summary>
+        /// Place using directives inside the namespace definition.
+        /// </summary>
+        InsideNamespace,
+
+        /// <summary>
+        /// Place using directives outside the namespace definition.
+        /// </summary>
+        OutsideNamespace,
+
+        /// <summary>
+        /// Allow using directives inside or outside the namespace definition.
+        /// </summary>
+        Preserve
+    }
+}

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

@@ -29,6 +29,16 @@
           "description": "Configuration for ordering rules (SA1200-)",
           "additionalProperties": false,
           "properties": {
+            "usingDirectivesPlacement": {
+              "type": "string",
+              "description": "Specifies the desired placement of using directives.\r\ninsideNamespace: Place using directives inside the namespace definition\r\noutsideNamespace: Place using directives outside the namespace definition\r\npreserve: Allow using directives inside or outside the namespace definition",
+              "enum": [
+                "insideNamespace",
+                "outsideNamespace",
+                "preserve"
+              ],
+              "default": "insideNamespace"
+            }
           }
         },
         "namingRules": {

StyleCop.Analyzers/StyleCop.Analyzers/StyleCop.Analyzers.csproj

@@ -279,6 +279,7 @@
     <Compile Include="Settings\ObjectModel\SettingsFile.cs" />
     <Compile Include="Settings\ObjectModel\SpacingSettings.cs" />
     <Compile Include="Settings\ObjectModel\StyleCopSettings.cs" />
+    <Compile Include="Settings\ObjectModel\UsingDirectivesPlacement.cs" />
     <Compile Include="Settings\SettingsHelper.cs" />
     <Compile Include="Settings\SettingsResources.Designer.cs">
       <AutoGen>True</AutoGen>