Merge pull request #658 from PowerShell/kapilmb/FixAvoidGlobalRules

Fix AvoidGlobalAliases and AvoidGlobalFunctions rules

Author: Kapil Borle

Engine/Helper.cs

@@ -1775,6 +1775,19 @@ public static bool IsPowerShellVersionSupported(Version version)
             return version >= minSupportedPSVersion;
         }
 
+        /// <summary>
+        /// Determines if analyzing a script module.
+        /// </summary>
+        /// <returns>True is file name ends with ".psm1"</returns>
+        public static bool IsModuleScript(string filepath)
+        {
+            if (filepath == null)
+            {
+                throw new ArgumentNullException("filepath");
+            }
+            return filepath.EndsWith(".psm1");
+        }
+
         /// <summary>
         /// Checks if a given file is a valid PowerShell module manifest
         /// </summary>

Rules/AvoidGlobalAliases.cs

@@ -33,7 +33,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             records = new List<DiagnosticRecord>();
             this.fileName = fileName;
 
-            if (IsScriptModule())
+            if (fileName != null && Helper.IsModuleScript(fileName))
             {
                 ast.Visit(this);
             }
@@ -95,15 +95,6 @@ private bool IsNewAliasCmdlet(CommandAst commandAst)
             return false;
         }
 
-        /// <summary>
-        /// Determines if analyzing a script module.
-        /// </summary>
-        /// <returns>True is file name ends with ".psm1"</returns>
-        private bool IsScriptModule()
-        {
-            return fileName.EndsWith(".psm1");
-        }
-
         public string GetCommonName()
         {
              return string.Format(CultureInfo.CurrentCulture, Strings.AvoidGlobalAliasesCommonName);
@@ -116,7 +107,11 @@ public string GetDescription()
 
         public string GetName()
         {
-            return string.Format(CultureInfo.CurrentCulture, Strings.AvoidGlobalAliasesName);
+            return string.Format(
+                CultureInfo.CurrentCulture,
+                Strings.NameSpaceFormat,
+                GetSourceName(),
+                Strings.AvoidGlobalAliasesName);
         }
 
         public RuleSeverity GetSeverity()

Rules/AvoidGlobalFunctions.cs

@@ -33,7 +33,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             records = new List<DiagnosticRecord>();
             this.fileName = fileName;
 
-            if (IsScriptModule())
+            if (fileName != null && Helper.IsModuleScript(fileName))
             {
                 ast.Visit(this);
             }
@@ -66,15 +66,6 @@ public override AstVisitAction VisitFunctionDefinition(FunctionDefinitionAst fun
         }
         #endregion
 
-        /// <summary>
-        /// Determines if analyzing a script module.
-        /// </summary>
-        /// <returns>True is file name ends with ".psm1"</returns>
-        private bool IsScriptModule()
-        {
-            return fileName.EndsWith(".psm1");
-        }
-
         public string GetCommonName()
         {
             return string.Format(CultureInfo.CurrentCulture, Strings.AvoidGlobalFunctionsCommonName);
@@ -87,7 +78,11 @@ public string GetDescription()
 
         public string GetName()
         {
-            return string.Format(CultureInfo.CurrentCulture, Strings.AvoidGlobalFunctionsName);
+            return string.Format(
+                CultureInfo.CurrentCulture,
+                Strings.NameSpaceFormat,
+                GetSourceName(),
+                Strings.AvoidGlobalFunctionsName);
         }
 
         public RuleSeverity GetSeverity()

Tests/Rules/AvoidGlobalAliases.tests.ps1

@@ -1,7 +1,7 @@
 Import-Module PSScriptAnalyzer
 
 $AvoidGlobalAliasesError = "Avoid creating aliases with a Global scope."
-$violationName = "AvoidGlobalAliases"
+$violationName = "PSAvoidGlobalAliases"
 
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path
 $violations = Invoke-ScriptAnalyzer $directory\AvoidGlobalAliases.psm1 | Where-Object {$_.RuleName -eq $violationName}

Tests/Rules/AvoidGlobalFunctions.tests.ps1

@@ -1,7 +1,7 @@
 Import-Module PSScriptAnalyzer
 
 $functionErroMessage = "Avoid creating functions with a Global scope."
-$violationName = "AvoidGlobalFunctions"
+$violationName = "PSAvoidGlobalFunctions"
 
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path
 $violations = Invoke-ScriptAnalyzer $directory\AvoidGlobalFunctions.psm1 | Where-Object {$_.RuleName -eq $violationName}