Merge pull request #2732 from pdelvo/fixallstatus

Re-Add fix all status to the status page

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/FixAllStatus.cs

@@ -0,0 +1,27 @@
+// 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.Status.Generator
+{
+    /// <summary>
+    /// This enum captures the status of the implementation of a fix all provider.
+    /// </summary>
+    public enum FixAllStatus
+    {
+        /// <summary>
+        /// No fix all provider is implemented for the given code fix.
+        /// </summary>
+        None,
+
+        /// <summary>
+        /// The fix all provider for this code fix uses a custom optimized implementation.
+        /// </summary>
+        CustomImplementation,
+
+        /// <summary>
+        /// The fix all capability is provided by the default batch fixer.
+        /// This implementation might have various problems e.g. bad performance or it might not fix all problems at once.
+        /// </summary>
+        BatchFixer,
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/SolutionReader.cs

@@ -37,6 +37,7 @@ public class SolutionReader
         private Compilation analyzerCompilation;
         private Compilation codeFixCompilation;
         private ITypeSymbol booleanType;
+        private Type batchFixerType;
 
         private SolutionReader()
         {
@@ -99,7 +100,6 @@ public async Task<ImmutableList<StyleCopDiagnostic>> GetDiagnosticsAsync()
                 }
 
                 string shortName = match.Groups["name"].Value;
-                CodeFixStatus codeFixStatus;
                 string noCodeFixReason = null;
 
                 // Check if this syntax tree represents a diagnostic
@@ -130,7 +130,7 @@ public async Task<ImmutableList<StyleCopDiagnostic>> GetDiagnosticsAsync()
 
                 foreach (var descriptorInfo in descriptorInfos)
                 {
-                    codeFixStatus = this.HasCodeFix(descriptorInfo.Id, classSymbol, out noCodeFixReason);
+                    var (codeFixStatus, fixAllStatus) = this.GetCodeFixAndFixAllStatus(descriptorInfo.Id, classSymbol, out noCodeFixReason);
                     string status = this.GetStatus(classSymbol, syntaxRoot, semanticModel, descriptorInfo);
                     if (descriptorInfo.CustomTags.Contains(WellKnownDiagnosticTags.NotConfigurable))
                     {
@@ -147,6 +147,7 @@ public async Task<ImmutableList<StyleCopDiagnostic>> GetDiagnosticsAsync()
                         Title = descriptorInfo.Title.ToString(),
                         HelpLink = descriptorInfo.HelpLinkUri,
                         CodeFixStatus = codeFixStatus,
+                        FixAllStatus = fixAllStatus,
                         NoCodeFixReason = noCodeFixReason,
                     };
                     diagnostics.Add(diagnostic);
@@ -192,6 +193,8 @@ private async Task InitializeAsync()
             this.noCodeFixAttributeTypeSymbol = this.analyzerCompilation.GetTypeByMetadataName("StyleCop.Analyzers.NoCodeFixAttribute");
             this.diagnosticAnalyzerTypeSymbol = this.analyzerCompilation.GetTypeByMetadataName(typeof(DiagnosticAnalyzer).FullName);
 
+            this.batchFixerType = this.codeFixAssembly.GetType("StyleCop.Analyzers.Helpers.CustomBatchFixAllProvider");
+
             this.InitializeCodeFixTypes();
         }
 
@@ -284,18 +287,22 @@ private IEnumerable<DiagnosticDescriptor> GetDescriptor(INamedTypeSymbol classSy
             return analyzer.SupportedDiagnostics;
         }
 
-        private CodeFixStatus HasCodeFix(string diagnosticId, INamedTypeSymbol classSymbol, out string noCodeFixReason)
+        private (CodeFixStatus, FixAllStatus) GetCodeFixAndFixAllStatus(string diagnosticId, INamedTypeSymbol classSymbol, out string noCodeFixReason)
         {
-            CodeFixStatus status;
+            CodeFixStatus codeFixStatus;
+            FixAllStatus fixAllStatus;
 
             noCodeFixReason = null;
 
-            var noCodeFixAttribute = classSymbol.GetAttributes().SingleOrDefault(x => x.AttributeClass == this.noCodeFixAttributeTypeSymbol);
+            var noCodeFixAttribute = classSymbol
+                .GetAttributes()
+                .SingleOrDefault(x => x.AttributeClass == this.noCodeFixAttributeTypeSymbol);
 
             bool hasCodeFix = noCodeFixAttribute == null;
             if (!hasCodeFix)
             {
-                status = CodeFixStatus.NotImplemented;
+                codeFixStatus = CodeFixStatus.NotImplemented;
+                fixAllStatus = FixAllStatus.None;
                 if (noCodeFixAttribute.ConstructorArguments.Length > 0)
                 {
                     noCodeFixReason = noCodeFixAttribute.ConstructorArguments[0].Value as string;
@@ -304,12 +311,45 @@ private CodeFixStatus HasCodeFix(string diagnosticId, INamedTypeSymbol classSymb
             else
             {
                 // Check if the code fix actually exists
-                hasCodeFix = this.CodeFixProviders.Any(x => x.FixableDiagnosticIds.Contains(diagnosticId));
+                var codeFixes = this.CodeFixProviders
+                    .Where(x => x.FixableDiagnosticIds.Contains(diagnosticId))
+                    .Select(x => this.IsBatchFixer(x))
+                    .Where(x => x != null)
+                    .Select(x => (bool)x).ToArray();
+
+                hasCodeFix = codeFixes.Length > 0;
+
+                codeFixStatus = hasCodeFix ? CodeFixStatus.Implemented : CodeFixStatus.NotYetImplemented;
 
-                status = hasCodeFix ? CodeFixStatus.Implemented : CodeFixStatus.NotYetImplemented;
+                if (codeFixes.Any(x => x))
+                {
+                    fixAllStatus = FixAllStatus.BatchFixer;
+                }
+                else if (codeFixes.Length > 0)
+                {
+                    fixAllStatus = FixAllStatus.CustomImplementation;
+                }
+                else
+                {
+                    fixAllStatus = FixAllStatus.None;
+                }
             }
 
-            return status;
+            return (codeFixStatus, fixAllStatus);
+        }
+
+        private bool? IsBatchFixer(CodeFixProvider provider)
+        {
+            var fixAllProvider = provider.GetFixAllProvider();
+
+            if (fixAllProvider == null)
+            {
+                return null;
+            }
+            else
+            {
+                return fixAllProvider.GetType() == this.batchFixerType;
+            }
         }
 
         private bool InheritsFrom(INamedTypeSymbol declaration, INamedTypeSymbol possibleBaseType)

StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/StyleCopDiagnostic.cs

@@ -59,6 +59,15 @@ public class StyleCopDiagnostic
         [JsonConverter(typeof(StringEnumConverter))]
         public CodeFixStatus CodeFixStatus { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value that represents how the fix all functionality is implemented.
+        /// </summary>
+        /// <value>
+        /// A value that represents how the fix all functionality is implemented.
+        /// </value>
+        [JsonConverter(typeof(StringEnumConverter))]
+        public FixAllStatus FixAllStatus { get; set; }
+
         /// <summary>
         /// Gets or sets the reason why a code fix is not implemented, or <see langword="null"/> if there is
         /// no reason.

docs/index.html

@@ -4,7 +4,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>StyleCopAnalyzers Status</title>
-    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.3.0/css/font-awesome.min.css" />
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css" />
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/css/bootstrap.min.css" />
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/css/bootstrap-theme.min.css" />
 
@@ -78,6 +78,9 @@ <h2>This page is reporting the current status of <a href="https://github.com/Dot
                     <td style="overflow: visible; width: 0;">
                         Code Fix
                     </td>
+                    <td style="overflow: visible; width: 0;">
+                        Fix All Provider
+                    </td>
                     <td></td>
                 </tr>
             </thead>
@@ -122,6 +125,15 @@ <h2>This page is reporting the current status of <a href="https://github.com/Dot
                 {{else CodeFixStatus === NotImplemented}}
                 <i class="fa fa-times" style="color: red;"></i>
                 {{else}}
+                <i class="fa fa-exclamation" style="color: blue;"></i>
+                {{/if}}
+            </td>
+            <td style="overflow: visible; width: 0;">
+                {{if FixAllStatus === "BatchFixer"}}
+                <i class="fa fa-hourglass" style="color: blue;"></i>
+                {{else FixAllStatus === "CustomImplementation"}}
+                <i class="fa fa-check" style="color: green;"></i>
+                {{else}}
                 <i class="fa fa-times" style="color: red;"></i>
                 {{/if}}
             </td>