Implement SupportShouldProcess for InvokeScriptAnalyzerCommand down to a per process path and per file basis.

Propagating it further down would not make sense because then it would need to analyze all files, in this case SupportShouldContinue could be implemented in the future.

Author: bergmeister

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -38,6 +38,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
     [Cmdlet(VerbsLifecycle.Invoke,
         "ScriptAnalyzer",
         DefaultParameterSetName = "File",
+        SupportsShouldProcess = true,
         HelpUri = "http://go.microsoft.com/fwlink/?LinkId=525914")]
     public class InvokeScriptAnalyzerCommand : PSCmdlet, IOutputWriter
     {
@@ -390,11 +391,13 @@ private void ProcessInput()
                 {
                     if (fix)
                     {
-                        diagnosticsList = ScriptAnalyzer.Instance.AnalyzeAndFixPath(p, this.recurse);
+                        ShouldProcess(p, $"Analyzing and fixing path with Recurse={this.recurse}");
+                        diagnosticsList = ScriptAnalyzer.Instance.AnalyzeAndFixPath(p, this.ShouldProcess, this.recurse);
                     }
                     else
                     {
-                        diagnosticsList = ScriptAnalyzer.Instance.AnalyzePath(p, this.recurse);
+                        ShouldProcess(p, $"Analyzing path with Recurse={this.recurse}");
+                        diagnosticsList = ScriptAnalyzer.Instance.AnalyzePath(p, this.ShouldProcess, this.recurse);
                     }
                     WriteToOutput(diagnosticsList);
                 }

Engine/ScriptAnalyzer.cs

@@ -1444,28 +1444,32 @@ public Dictionary<string, List<string>> CheckRuleExtension(string[] path, PathIn
             return results;
         }
 
-#endregion
+        #endregion
 
 
         /// <summary>
         /// Analyzes a script file or a directory containing script files.
         /// </summary>
         /// <param name="path">The path of the file or directory to analyze.</param>
+        /// <param name="shouldProcess">Whether the action should be executed.</param>
         /// <param name="searchRecursively">
         /// If true, recursively searches the given file path and analyzes any
         /// script files that are found.
         /// </param>
         /// <returns>An enumeration of DiagnosticRecords that were found by rules.</returns>
-        public IEnumerable<DiagnosticRecord> AnalyzePath(string path, bool searchRecursively = false)
+        public IEnumerable<DiagnosticRecord> AnalyzePath(string path, Func<string, string, bool> shouldProcess, bool searchRecursively = false)
         {
             List<string> scriptFilePaths = ScriptPathList(path, searchRecursively);
 
             foreach (string scriptFilePath in scriptFilePaths)
             {
-                // Yield each record in the result so that the caller can pull them one at a time
-                foreach (var diagnosticRecord in this.AnalyzeFile(scriptFilePath))
+                if (shouldProcess(scriptFilePath, $"Analyzing file {scriptFilePath}"))
                 {
-                    yield return diagnosticRecord;
+                    // Yield each record in the result so that the caller can pull them one at a time
+                    foreach (var diagnosticRecord in this.AnalyzeFile(scriptFilePath))
+                    {
+                        yield return diagnosticRecord;
+                    }
                 }
             }
         }
@@ -1474,25 +1478,29 @@ public IEnumerable<DiagnosticRecord> AnalyzePath(string path, bool searchRecursi
         /// Analyzes a script file or a directory containing script files and fixes warning where possible.
         /// </summary>
         /// <param name="path">The path of the file or directory to analyze.</param>
+        /// <param name="shouldProcess">Whether the action should be executed.</param>
         /// <param name="searchRecursively">
         /// If true, recursively searches the given file path and analyzes any
         /// script files that are found.
         /// </param>
         /// <returns>An enumeration of DiagnosticRecords that were found by rules and could not be fixed automatically.</returns>
-        public IEnumerable<DiagnosticRecord> AnalyzeAndFixPath(string path, bool searchRecursively = false)
+        public IEnumerable<DiagnosticRecord> AnalyzeAndFixPath(string path, Func<string, string, bool> shouldProcess, bool searchRecursively = false)
         {
             List<string> scriptFilePaths = ScriptPathList(path, searchRecursively);
 
             foreach (string scriptFilePath in scriptFilePaths)
             {
-                var fileEncoding = GetFileEncoding(scriptFilePath);
-                var scriptFileContentWithFixes = Fix(File.ReadAllText(scriptFilePath, fileEncoding));
-                File.WriteAllText(scriptFilePath, scriptFileContentWithFixes, fileEncoding);
-
-                // Yield each record in the result so that the caller can pull them one at a time
-                foreach (var diagnosticRecord in this.AnalyzeFile(scriptFilePath))
+                if (shouldProcess(scriptFilePath, $"Analyzing and fixing file {scriptFilePath}"))
                 {
-                    yield return diagnosticRecord;
+                    var fileEncoding = GetFileEncoding(scriptFilePath);
+                    var scriptFileContentWithFixes = Fix(File.ReadAllText(scriptFilePath, fileEncoding));
+                    File.WriteAllText(scriptFilePath, scriptFileContentWithFixes, fileEncoding);
+
+                    // Yield each record in the result so that the caller can pull them one at a time
+                    foreach (var diagnosticRecord in this.AnalyzeFile(scriptFilePath))
+                    {
+                        yield return diagnosticRecord;
+                    }
                 }
             }
         }