Merge pull request #3927 from DWIAltonaAnalytics/#3926

update SA1518 to ignore empty (0 bytes) files

Author: sharwell

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

@@ -29,6 +29,8 @@ public void Bar(int i)
     }
 }";
 
+        private const string WhiteSpace = "\t  ";
+
         /// <summary>
         /// Verifies that blank lines at the end of the file will produce a warning.
         /// </summary>
@@ -49,6 +51,83 @@ internal async Task TestWithBlankLinesAtEndOfFileAsync(OptionSetting? newlineAtE
             await VerifyCSharpFixAsync(newlineAtEndOfFile, testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Verifies file with white space only and no cr/lf at end of file will produce a warning when setting requires.
+        /// </summary>
+        /// <param name="newlineAtEndOfFile">The effective <see cref="OptionSetting"/> setting.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Theory]
+        [InlineData(null)]
+        [InlineData(OptionSetting.Allow)]
+        [InlineData(OptionSetting.Require)]
+        [InlineData(OptionSetting.Omit)]
+        internal async Task TestWithWhiteSpaceOnlyAsync(OptionSetting? newlineAtEndOfFile)
+        {
+            var testCode = WhiteSpace;
+
+            var fixedCode = newlineAtEndOfFile switch
+            {
+                OptionSetting.Require => "\r\n",
+                _ => null,
+            };
+
+            if (fixedCode == null)
+            {
+                await VerifyCSharpDiagnosticAsync(newlineAtEndOfFile, testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+            }
+            else
+            {
+                var expected = Diagnostic(this.GetDescriptor(newlineAtEndOfFile)).WithLocation(1, 1);
+                await VerifyCSharpFixAsync(newlineAtEndOfFile, testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
+            }
+        }
+
+        /// <summary>
+        /// Verifies file with white space only and cr/lf at end of file will produce a warning when setting requires.
+        /// </summary>
+        /// <param name="newlineAtEndOfFile">The effective <see cref="OptionSetting"/> setting.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Theory]
+        [InlineData(null)]
+        [InlineData(OptionSetting.Allow)]
+        [InlineData(OptionSetting.Require)]
+        [InlineData(OptionSetting.Omit)]
+        internal async Task TestWithWhiteSpaceAndNewlineOnlyAsync(OptionSetting? newlineAtEndOfFile)
+        {
+            var testCode = WhiteSpace + "\r\n";
+            var fixedCode = newlineAtEndOfFile switch
+            {
+                OptionSetting.Omit => string.Empty,
+                _ => null,
+            };
+
+            if (fixedCode == null)
+            {
+                await VerifyCSharpDiagnosticAsync(newlineAtEndOfFile, testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+            }
+            else
+            {
+                var expected = Diagnostic(this.GetDescriptor(newlineAtEndOfFile)).WithLocation(1, 1);
+                await VerifyCSharpFixAsync(newlineAtEndOfFile, testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
+            }
+        }
+
+        /// <summary>
+        /// Verifies that empty files will not produce a warning.
+        /// </summary>
+        /// <param name="newlineAtEndOfFile">The effective <see cref="OptionSetting"/> setting.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Theory]
+        [InlineData(null)]
+        [InlineData(OptionSetting.Allow)]
+        [InlineData(OptionSetting.Require)]
+        [InlineData(OptionSetting.Omit)]
+        internal async Task TestWithEmptyFileAsync(OptionSetting? newlineAtEndOfFile)
+        {
+            var testCode = string.Empty;
+            await VerifyCSharpDiagnosticAsync(newlineAtEndOfFile, testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
         /// <summary>
         /// Verifies that linefeed only blank lines at the end of the file will produce a warning.
         /// </summary>

StyleCop.Analyzers/StyleCop.Analyzers/Helpers/SyntaxTreeHelpers.cs

@@ -67,5 +67,10 @@ public static bool IsWhitespaceOnly(this SyntaxTree tree, CancellationToken canc
             return firstToken.IsKind(SyntaxKind.EndOfFileToken)
                 && TriviaHelper.IndexOfFirstNonWhitespaceTrivia(firstToken.LeadingTrivia) == -1;
         }
+
+        public static bool IsEmpty(this SyntaxTree tree)
+        {
+            return tree.Length == 0;
+        }
     }
 }

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

@@ -72,6 +72,12 @@ public override void Initialize(AnalysisContext context)
 
         private static void HandleSyntaxTree(SyntaxTreeAnalysisContext context, StyleCopSettings settings)
         {
+            if (context.Tree.IsEmpty())
+            {
+                // Empty files never contain line endings.
+                return;
+            }
+
             var endOfFileToken = context.Tree.GetRoot().GetLastToken(includeZeroWidth: true);
             TextSpan reportedSpan = new TextSpan(endOfFileToken.SpanStart, 0);