Clarified documentation, removed indentation, and added additional tests

Author: THammond9

StyleCop.Analyzers/StyleCop.Analyzers.Test/SpacingRules/SA1001UnitTests.cs

@@ -190,6 +190,24 @@ public async Task TestSpaceAfterCommaWhenPartOfInterpolationAlignmentClauseAsync
             await this.TestCommaInStatementOrDeclAsync(statement, expected, fixedStatement).ConfigureAwait(false);
         }
 
+        [Fact]
+        [WorkItem(2289, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2289")]
+        public async Task TestSpaceBeforeAndAfterCommaWhenPartOfInterpolationAlignmentClauseAsync()
+        {
+            string statement = @"var x = new[] { 1, 2, 3, 4, 5, 6, 7 };
+            var t = $""{x[2] , 3}"";";
+            string fixedStatement = @"var x = new[] { 1, 2, 3, 4, 5, 6, 7 };
+            var t = $""{x[2],3}"";";
+
+            DiagnosticResult[] expected =
+                {
+                    this.CSharpDiagnostic().WithArguments(" not", "preceded").WithLocation(8, 29),
+                    this.CSharpDiagnostic().WithArguments(" not", "followed").WithLocation(8, 29),
+                };
+
+            await this.TestCommaInStatementOrDeclAsync(statement, expected, fixedStatement).ConfigureAwait(false);
+        }
+
         [Fact]
         public async Task TestSpaceOnlyBeforeCommaAsync()
         {

StyleCop.Analyzers/StyleCop.Analyzers.Test/SpacingRules/SA1011UnitTests.cs

@@ -349,6 +349,24 @@ void Method()
             await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Fact]
+        [WorkItem(2289, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2289")]
+        public async Task TestCommaCanFollowSquareBracketWhenPartOfInterpolationFormatClauseAsync()
+        {
+            string testCode = @"
+class ClassName
+{
+    void Method()
+    {
+        var x = new[] { 1, 2, 3, 4, 5, 6, 7 };
+        var t = $""{ x[2],3}"";
+    }
+}
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
         /// <inheritdoc/>
         protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
         {

StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1001CommasMustBeSpacedCorrectly.cs

@@ -16,8 +16,8 @@ namespace StyleCop.Analyzers.SpacingRules
     /// <remarks>
     /// <para>A violation of this rule occurs when the spacing around a comma is incorrect.</para>
     ///
-    /// <para>A comma should always be followed by a single space, unless it is the last character on the line
-    /// or it is part of an alignment component, and a comma should never be preceded by any whitespace,
+    /// <para>A comma should always be followed by a single space, unless it is the last character on the line or it is
+    /// part of a string interpolation alignment component, and a comma should never be preceded by any whitespace,
     /// unless it is the first character on the line.</para>
     /// </remarks>
     [DiagnosticAnalyzer(LanguageNames.CSharp)]

StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1011ClosingSquareBracketsMustBeSpacedCorrectly.cs

@@ -22,8 +22,8 @@ namespace StyleCop.Analyzers.SpacingRules
     ///
     /// <para>A closing square bracket should be followed by whitespace, unless it is the last character on the line, it
     /// is followed by a closing bracket or an opening parenthesis, it is followed by a comma or semicolon, it is
-    /// followed by a alignment component or format string component, or it is followed by certain types of operator
-    /// symbols.</para>
+    /// followed by a string interpolation alignment component or string interpolation formatting component, or it is
+    /// followed by certain types of operator symbols.</para>
     /// </remarks>
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
     internal class SA1011ClosingSquareBracketsMustBeSpacedCorrectly : DiagnosticAnalyzer

StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1024ColonsMustBeSpacedCorrectly.cs

@@ -42,8 +42,8 @@ namespace StyleCop.Analyzers.SpacingRules
     /// }
     /// </code>
     ///
-    /// <para>A colon that appears as part of format string component should not have leading whitespace characters. For
-    /// example:</para>
+    /// <para>A colon that appears as part of a string interpolation formatting component should not have leading
+    /// whitespace characters. For example:</para>
     ///
     /// <code language="cs">
     /// var s = $"{x:N}";

documentation/SA1001.md

@@ -27,7 +27,7 @@ A comma should be followed by a single space, except in the following cases.
 
 * A comma may appear at the end of a line
 * A comma should not be followed by a space when used in an open generic type in a `typeof` expression
-* A comma is part of an alignment component. For example:`$"{x,3}"`
+* A comma is part of a string interpolation alignment component. For example:`$"{x,3}"`
 
 A comma should never be preceded by a space or appear as the first token on a line.
 

documentation/SA1011.md

@@ -29,7 +29,8 @@ A closing square bracket should be followed by whitespace unless:
 * It is the last character on the line
 * It is followed by a closing bracket or an opening parenthesis
 * It is followed by a comma or semicolon
-* It is followed by a alignment component or format string component. For example: `$"{x[i],3}"` or `$"{x[i]:C}"`
+* It is followed by a string interpolation alignment component. For example: `$"{x[i]:C}"`
+* It is followed by a string interpolation formatting component. For example: `$"{x[i],3}"`
 * It is followed by certain types of operator symbols.
 
 ## How to fix violations

documentation/SA1024.md

@@ -45,7 +45,7 @@ switch (x)
 }
 ```
 
-A colon that appears as part of format string component should not have leading whitespace characters. For example:
+A colon that appears as part of a string interpolation formatting component should not have leading whitespace characters. For example:
 
 ```csharp
 var s = $"{x:N}";