Remove ICommandRule

Author: Quoc Truong

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -170,7 +170,6 @@ protected override void BeginProcessing()
             #region Verify rules
 
             rules = ScriptAnalyzer.Instance.ScriptRules.Union<IRule>(
-                    ScriptAnalyzer.Instance.CommandRules).Union<IRule>(
                     ScriptAnalyzer.Instance.TokenRules).Union<IRule>(
                     ScriptAnalyzer.Instance.ExternalRules ?? Enumerable.Empty<IExternalRule>());
 
@@ -333,68 +332,6 @@ private void AnalyzeFile(string filePath)
 
             #endregion
 
-            #region Run Command Rules
-
-            funcDefAsts = ast.FindAll(new Func<Ast, bool>((testAst) => (testAst is FunctionDefinitionAst)), true);
-            if (funcDefAsts != null)
-            {
-                foreach (FunctionDefinitionAst funcDefAst in funcDefAsts)
-                {
-                    //Create command info object here
-                    var sb = new StringBuilder();
-                    sb.AppendLine(funcDefAst.Extent.Text);
-                    sb.AppendFormat("Get-Command –CommandType Function –Name {0}", funcDefAst.Name);
-
-                    var funcDefPS = System.Management.Automation.PowerShell.Create(RunspaceMode.CurrentRunspace);
-                    funcDefPS.AddScript(sb.ToString());
-
-                    try
-                    {
-                        var commandInfo = funcDefPS.Invoke<CommandInfo>();
-
-                        foreach (CommandInfo cmdInfo in commandInfo)
-                        {
-                            cmdInfoTable.Add(new KeyValuePair<CommandInfo, IScriptExtent>(cmdInfo as CommandInfo, funcDefAst.Extent));
-                        }
-                    }
-                    catch (ParseException)
-                    {
-                        WriteError(new ErrorRecord(new CommandNotFoundException(),
-                            string.Format(CultureInfo.CurrentCulture, Strings.CommandInfoNotFound, funcDefAst.Name), 
-                            ErrorCategory.SyntaxError, funcDefAst));
-                    }
-                }
-            }
-
-            if (ScriptAnalyzer.Instance.CommandRules != null)
-            {
-                foreach (ICommandRule commandRule in ScriptAnalyzer.Instance.CommandRules)
-                {
-                    if ((includeRule == null || includeRule.Contains(commandRule.GetName(), StringComparer.OrdinalIgnoreCase)) &&
-                        (excludeRule == null || !excludeRule.Contains(commandRule.GetName(), StringComparer.OrdinalIgnoreCase)))
-                    {
-                        foreach (KeyValuePair<CommandInfo, IScriptExtent> commandInfo in cmdInfoTable)
-                        {
-                            WriteVerbose(string.Format(CultureInfo.CurrentCulture, Strings.VerboseRunningMessage, commandRule.GetName()));
-
-                            // Ensure that any unhandled errors from Rules are converted to non-terminating errors
-                            // We want the Engine to continue functioning even if one or more Rules throws an exception
-                            try
-                            {
-                                diagnostics.AddRange(commandRule.AnalyzeCommand(commandInfo.Key, commandInfo.Value, fileName));
-                            }
-                            catch (Exception commandRuleException)
-                            {
-                                WriteError(new ErrorRecord(commandRuleException, Strings.RuleErrorMessage, ErrorCategory.InvalidOperation, fileName));
-                                continue;
-                            }  
-                        }
-                    }
-                }
-            }
-
-            #endregion
-
             #region Run Token Rules
 
             if (ScriptAnalyzer.Instance.TokenRules != null)

Engine/Generic/ICommandRule.cs

@@ -55,9 +55,6 @@ public static ScriptAnalyzer Instance
         [ImportMany]
         public IEnumerable<IScriptRule> ScriptRules { get; private set; }
 
-        [ImportMany]
-        public IEnumerable<ICommandRule> CommandRules { get; private set; }
-
         [ImportMany]
         public IEnumerable<ITokenRule> TokenRules { get; private set; }
 
@@ -168,8 +165,7 @@ public IEnumerable<IRule> GetRule(string[] moduleNames, string[] ruleNames)
             IEnumerable<IExternalRule> externalRules = null;
 
             // Combines C# rules.
-            IEnumerable<IRule> rules = ScriptRules.Union<IRule>(CommandRules)
-                                                  .Union<IRule>(TokenRules)
+            IEnumerable<IRule> rules = ScriptRules.Union<IRule>(TokenRules)
                                                   .Union<IRule>(DSCResourceRules);
 
             // Gets PowerShell Rules.

Engine/ScriptAnalyzer.cs

@@ -54,7 +54,6 @@
     <Compile Include="Generic\AvoidParameterGeneric.cs" />
     <Compile Include="Generic\DiagnosticRecord.cs" />
     <Compile Include="Generic\ExternalRule.cs" />
-    <Compile Include="Generic\ICommandRule.cs" />
     <Compile Include="Generic\IDSCResourceRule.cs" />
     <Compile Include="Generic\IExternalRule.cs" />
     <Compile Include="Generic\ILogger.cs" />

Engine/ScriptAnalyzerEngine.csproj

@@ -17,27 +17,33 @@ namespace Microsoft.Windows.Powershell.ScriptAnalyzer.BuiltinRules
 {
 
     /// <summary>
-    /// AvoidReservedCharInCmdlet: Analyzes CommandInfos to check for reserved characters in cmdlet names.
+    /// AvoidReservedCharInCmdlet: Analyzes script to check for reserved characters in cmdlet names.
     /// </summary>
-    [Export(typeof(ICommandRule))]
-    public class AvoidReservedCharInCmdlet : ICommandRule
+    [Export(typeof(IScriptRule))]
+    public class AvoidReservedCharInCmdlet : IScriptRule
     {
         /// <summary>
-        /// AnalyzeCommand: Analyzes command infos to check for reserved characters in cmdlet names.
+        /// Analyze ast to check that all the cmdlet does not use reserved char
         /// </summary>
-        /// <param name="commandInfo">The current command info from the script</param>
-        /// <param name="extent">The current position in the script</param>
-        /// <param name="fileName">The script's file name</param>
-        /// <returns>A List of diagnostic results of this rule</returns>
-        public IEnumerable<DiagnosticRecord> AnalyzeCommand(CommandInfo commandInfo, IScriptExtent extent, string fileName) {
-            if (commandInfo == null) throw new ArgumentNullException(Strings.NullAstErrorMessage);
+        /// <param name="ast"></param>
+        /// <param name="fileName"></param>
+        /// <returns></returns>
+        public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
+        {
+            if (ast == null) throw new ArgumentNullException(Strings.NullAstErrorMessage);
+
+            IEnumerable<Ast> funcAsts = ast.FindAll(item => item is FunctionDefinitionAst, true);
 
-            string funcName = commandInfo.Name;
-            string reservedChars = Strings.ReserverCmdletChars; //Localize yes or no?
+            string reservedChars = Strings.ReserverCmdletChars;
 
-            if (funcName.Intersect(reservedChars).Count() > 0) {
-                yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.ReservedCmdletCharError, funcName), extent, GetName(), DiagnosticSeverity.Warning, fileName);
-            }
+            foreach (FunctionDefinitionAst funcAst in funcAsts)
+            {
+                if (funcAst.Name != null && funcAst.Name.Intersect(reservedChars).Count() > 0)
+                {
+                    yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.ReservedCmdletCharError, funcAst.Name),
+                        funcAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                }
+            }            
         }
 
         /// <summary>

Rules/AvoidReservedCharInCmdlet.cs

@@ -16,19 +16,18 @@
 namespace Microsoft.Windows.Powershell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// UseApprovedVerbs: Analyzes CommandInfos to check that all defined cmdlets use approved verbs.
+    /// UseApprovedVerbs: Analyzes scripts to check that all defined functions use approved verbs.
     /// </summary>
-    [Export(typeof(ICommandRule))]
-    public class UseApprovedVerbs : ICommandRule {
+    [Export(typeof(IScriptRule))]
+    public class UseApprovedVerbs : IScriptRule {
         /// <summary>
-        /// AnalyzeCommand: Analyzes command infos to check that all defined cmdlets use approved verbs.
+        /// Analyze script to check that all defined functions use approved verbs
         /// </summary>
-        /// <param name="commandInfo">The current command info from the script</param>
-        /// <param name="extent">The current position in the script</param>
-        /// <param name="fileName">The name of the script</param>
-        /// <returns>A List of diagnostic results of this rule</returns>
-        public IEnumerable<DiagnosticRecord> AnalyzeCommand(CommandInfo commandInfo, IScriptExtent extent, string fileName) {
-            if (commandInfo == null) throw new ArgumentNullException(Strings.NullCommandInfoError);
+        /// <param name="ast"></param>
+        /// <param name="fileName"></param>
+        /// <returns></returns>
+        public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName) {
+            if (ast == null) throw new ArgumentNullException(Strings.NullAstErrorMessage);
 
             List<string> approvedVerbs = typeof(VerbsCommon).GetFields().Concat<FieldInfo>(
                 typeof(VerbsCommunications).GetFields()).Concat<FieldInfo>(
@@ -44,14 +43,22 @@ public IEnumerable<DiagnosticRecord> AnalyzeCommand(CommandInfo commandInfo, ISc
             string[] funcNamePieces = new string[2];
             string verb;
 
-            funcName = commandInfo.Name;
+            IEnumerable<Ast> funcAsts = ast.FindAll(item => item is FunctionDefinitionAst, true);
 
-            if (funcName != null && funcName.Contains('-')) {
-                funcNamePieces = funcName.Split(funcSeperator);
-                verb = funcNamePieces[0];
+            foreach (FunctionDefinitionAst funcAst in funcAsts)
+            {
+                funcName = funcAst.Name;
 
-                if (!approvedVerbs.Contains(verb, StringComparer.OrdinalIgnoreCase)) {
-                    yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.UseApprovedVerbsError, funcName), extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                if (funcName != null && funcName.Contains('-'))
+                {
+                    funcNamePieces = funcName.Split(funcSeperator);
+                    verb = funcNamePieces[0];
+
+                    if (!approvedVerbs.Contains(verb, StringComparer.OrdinalIgnoreCase))
+                    {
+                        yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.UseApprovedVerbsError, funcName),
+                            funcAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                    }
                 }
             }
         }

Rules/UseApprovedVerbs.cs

@@ -16,33 +16,41 @@
 namespace Microsoft.Windows.Powershell.ScriptAnalyzer.BuiltinRules
 {
     /// <summary>
-    /// CmdletSingularNoun: Analyzes CommandInfos to check that all defined cmdlets use singular nouns.
+    /// CmdletSingularNoun: Analyzes scripts to check that all defined cmdlets use singular nouns.
     /// 
     /// </summary>
-    [Export(typeof(ICommandRule))]
-    public class CmdletSingularNoun : ICommandRule {
+    [Export(typeof(IScriptRule))]
+    public class CmdletSingularNoun : IScriptRule {
         /// <summary>
-        /// AnalyzeCommand: Analyzes command infos to check that all defined cmdlets use singular nouns.
+        /// Checks that all defined cmdlet use singular noun
         /// </summary>
-        /// <param name="commandInfo">The current command info from the script</param>
-        /// <param name="extent">The current position in the script</param>
-        /// <param name="fileName">The name of the script</param>
-        /// <returns>A List of diagnostic results of this rule</returns>
-        public IEnumerable<DiagnosticRecord> AnalyzeCommand(CommandInfo commandInfo, IScriptExtent extent, string fileName) {
-            if (commandInfo == null) throw new ArgumentNullException(Strings.NullCommandInfoError);
+        /// <param name="ast"></param>
+        /// <param name="fileName"></param>
+        /// <returns></returns>
+        public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName) {
+            if (ast == null) throw new ArgumentNullException(Strings.NullCommandInfoError);
+
+            IEnumerable<Ast> funcAsts = ast.FindAll(item => item is FunctionDefinitionAst, true);
 
             char[] funcSeperator = { '-' };
             string[] funcNamePieces = new string[2];
 
-            if (commandInfo.Name != null && commandInfo.Name.Contains('-')) {
-                funcNamePieces = commandInfo.Name.Split(funcSeperator);
-                String noun = funcNamePieces[1];
-                var ps = System.Data.Entity.Design.PluralizationServices.PluralizationService.CreateService(CultureInfo.GetCultureInfo("en-us"));
+            foreach (FunctionDefinitionAst funcAst in funcAsts)
+            {
+                if (funcAst.Name != null && funcAst.Name.Contains('-'))
+                {
+                    funcNamePieces = funcAst.Name.Split(funcSeperator);
+                    String noun = funcNamePieces[1];
+                    var ps = System.Data.Entity.Design.PluralizationServices.PluralizationService.CreateService(CultureInfo.GetCultureInfo("en-us"));
 
-                if (ps.IsPlural(noun)) {
-                    yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.UseSingularNounsError, commandInfo.Name), extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                    if (ps.IsPlural(noun))
+                    {
+                        yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.UseSingularNounsError, funcAst.Name),
+                            funcAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                    }
                 }
             }
+
         }
 
         /// <summary>

Rules/UseSingularNouns.cs

@@ -1,6 +1,6 @@
 Import-Module ScriptAnalyzer
-$nounViolationMessage = "The cmdlet Verb-Files uses a plural noun. A singular noun should be used instead."
-$verbViolationMessage = "The cmdlet Verb-Files uses an unapproved verb."
+$nounViolationMessage = "The cmdlet 'Verb-Files' uses a plural noun. A singular noun should be used instead."
+$verbViolationMessage = "The cmdlet 'Verb-Files' uses an unapproved verb."
 $nounViolationName = "PSUseSingularNouns"
 $verbViolationName = "PSUseApprovedVerbs"
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path