Merge pull request #61 from sharwell/document-severity

Document severity

Author: sharwell

DocumentationAnalyzers/DocumentationAnalyzers.Status.Generator/DocumentationDiagnostic.cs

@@ -28,12 +28,12 @@ public class DocumentationDiagnostic
         public string Name { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether the diagnostic is implemented.
+        /// Gets or sets the default diagnostic severity.
         /// </summary>
         /// <value>
-        /// <see langword="true"/> if the diagnostic is implemented; otherwise <see langword="false"/>.
+        /// The default diagnostic severity.
         /// </value>
-        public bool HasImplementation { get; set; }
+        public string Severity { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether the diagnostic is enabled. This can indicate if the

DocumentationAnalyzers/DocumentationAnalyzers.Status.Generator/SolutionReader.cs

@@ -123,8 +123,6 @@ public async Task<ImmutableList<DocumentationDiagnostic>> GetDiagnosticsAsync()
                     continue;
                 }
 
-                bool hasImplementation = HasImplementation(syntaxRoot);
-
                 IEnumerable<DiagnosticDescriptor> descriptorInfos = GetDescriptor(classSymbol);
 
                 foreach (var descriptorInfo in descriptorInfos)
@@ -140,7 +138,7 @@ public async Task<ImmutableList<DocumentationDiagnostic>> GetDiagnosticsAsync()
                     {
                         Id = descriptorInfo.Id,
                         Category = descriptorInfo.Category,
-                        HasImplementation = hasImplementation,
+                        Severity = descriptorInfo.DefaultSeverity.ToString(),
                         Status = status,
                         Name = shortName,
                         Title = descriptorInfo.Title.ToString(),
@@ -156,23 +154,6 @@ public async Task<ImmutableList<DocumentationDiagnostic>> GetDiagnosticsAsync()
             return diagnostics.ToImmutable();
         }
 
-        private static bool HasImplementation(SyntaxNode syntaxRoot)
-        {
-            bool hasImplementation = true;
-            foreach (var trivia in syntaxRoot.DescendantTrivia())
-            {
-                if (trivia.IsKind(SyntaxKind.SingleLineCommentTrivia))
-                {
-                    if (trivia.ToFullString().Contains("TODO: Implement analysis"))
-                    {
-                        hasImplementation = false;
-                    }
-                }
-            }
-
-            return hasImplementation;
-        }
-
         private async Task InitializeAsync()
         {
             _solution = await _workspace.OpenSolutionAsync(SlnPath).ConfigureAwait(false);

docs/index.html

@@ -70,7 +70,7 @@ <h2>This page is reporting the current status of <a href="https://github.com/Dot
                         Title
                     </td>
                     <td>
-                        Has Implementation
+                        Severity
                     </td>
                     <td>
                         Status
@@ -91,15 +91,11 @@ <h2>This page is reporting the current status of <a href="https://github.com/Dot
     </div>
 
     <script id="diagnostic-color" type="text/x-jsrender">
-        {{if HasImplementation}}
         {{if Status !== "DisabledNoTests"}}
         success
         {{else}}
         warning
         {{/if}}
-        {{else }}
-        danger
-        {{/if}}
     </script>
 
     <script id="diagnostic" type="text/x-jsrender">
@@ -114,7 +110,7 @@ <h2>This page is reporting the current status of <a href="https://github.com/Dot
                 {{>Title}}
             </td>
             <td>
-                {{>HasImplementation}}
+                {{>Severity}}
             </td>
             <td>
                 {{>Status}}
@@ -173,7 +169,10 @@ <h3>Commit information</h3>
     </script>
 
     <script type="text/javascript">
-        $.getJSON("https://ci.appveyor.com/api/projects/sharwell/Documentationanalyzers/artifacts/DocumentationAnalyzers.Status.json?branch=master&pr=false&stream=true&job=Configuration:%20Release", function (data) {
+        var urlParams = new URLSearchParams(window.location.search);
+        var branch = urlParams.get('branch') || 'master';
+        var pr = urlParams.get('pr') === 'true' ? 'true' : 'false';
+        $.getJSON(`https://ci.appveyor.com/api/projects/sharwell/Documentationanalyzers/artifacts/DocumentationAnalyzers.Status.json?branch=${branch}&pr=${pr}&stream=true&job=Configuration:%20Release`, function (data) {
             $("#renderedDiagnostics").html($.templates($("#diagnostics").html()).render(data));
             $("#renderedCommitInfo").html($.templates($("#commitInfo").html()).render(data.git));
         });