Use ViolationFinder class to find comment help violations

Author: Kapil Borle

Rules/ProvideCommentHelp.cs

@@ -30,9 +30,8 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif
-    public class ProvideCommentHelp : SkipTypeDefinition, IScriptRule
+    public class ProvideCommentHelp : IScriptRule
     {
-        private HashSet<string> exportedFunctions;
 
         /// <summary>
         /// AnalyzeScript: Analyzes the ast to check that cmdlets have help.
@@ -44,47 +43,20 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         {
             if (ast == null) throw new ArgumentNullException(Strings.NullAstErrorMessage);
 
-            DiagnosticRecords.Clear();
-            this.fileName = fileName;
-            exportedFunctions = Helper.Instance.GetExportedFunction(ast);
-
-            ast.Visit(this);
-
-            return DiagnosticRecords;
-        }
-
-        /// <summary>
-        /// Visit function and checks that it has comment help
-        /// </summary>
-        /// <param name="funcAst"></param>
-        /// <returns></returns>
-        public override AstVisitAction VisitFunctionDefinition(FunctionDefinitionAst funcAst)
-        {
-            if (funcAst == null)
-            {
-                return AstVisitAction.SkipChildren;
-            }
-
-            if (exportedFunctions.Contains(funcAst.Name))
+            var exportedFunctions = Helper.Instance.GetExportedFunction(ast);
+            var violationFinder = new ViolationFinder(exportedFunctions);
+            ast.Visit(violationFinder);
+            foreach (var functionDefinitionAst in violationFinder.FunctionDefinitionAsts)
             {
-                if (funcAst.GetHelpContent() == null)
-                {
-                    // todo create auto correction
-                    // todo add option to add help for non exported members
-                    // todo add option to set help location
-                    DiagnosticRecords.Add(
-                        new DiagnosticRecord(
-                            string.Format(CultureInfo.CurrentCulture, Strings.ProvideCommentHelpError, funcAst.Name),
-                            Helper.Instance.GetScriptExtentForFunctionName(funcAst),
-                            GetName(),
-                            DiagnosticSeverity.Information,
-                            fileName,
-                            null,
-                            GetCorrection(funcAst).ToList()));
-                }
+                yield return new DiagnosticRecord(
+                        String.Format(CultureInfo.CurrentCulture, Strings.ProvideCommentHelpError, functionDefinitionAst.Name),
+                        Helper.Instance.GetScriptExtentForFunctionName(functionDefinitionAst),
+                        GetName(),
+                        GetDiagnosticSeverity(),
+                        fileName,
+                        null,
+                        GetCorrection(functionDefinitionAst).ToList());
             }
-
-            return AstVisitAction.Continue;
         }
 
         /// <summary>
@@ -139,6 +111,11 @@ public string GetSourceName()
             return string.Format(CultureInfo.CurrentCulture, Strings.SourceName);
         }
 
+        private DiagnosticSeverity GetDiagnosticSeverity()
+        {
+            return DiagnosticSeverity.Information;
+        }
+
         private IEnumerable<CorrectionExtent> GetCorrection(FunctionDefinitionAst funcDefnAst)
         {
             var helpBuilder = new CommentHelpBuilder();
@@ -247,6 +224,7 @@ public override string ToString()
                 sb.Append(notes.ToString());
                 return sb.ToString();
             }
+
             private class CommentHelpNode
             {
                 public CommentHelpNode(string nodeName, string description)