Merge pull request #671 from PowerShell/kapilmb/AvoidGlobalAliasesRule

Add PSAvoidGlobalAliases to PS Core and remove from PSv3

Author: Kapil Borle

Rules/AvoidGlobalAliases.cs

@@ -1,4 +1,5 @@
-using System;
+#if !PSV3
+using System;
 using System.Collections.Generic;
 #if !CORECLR
 using System.ComponentModel.Composition;
@@ -12,7 +13,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif
-    class AvoidGlobalAliases : AstVisitor, IScriptRule
+    public class AvoidGlobalAliases : AstVisitor, IScriptRule
     {
         private List<DiagnosticRecord> records;
         private string fileName;
@@ -130,3 +131,5 @@ public SourceType GetSourceType()
         }
     }
 }
+
+#endif // !PSV3

Tests/Engine/GetScriptAnalyzerRule.tests.ps1

@@ -62,8 +62,14 @@ Describe "Test Name parameters" {
         It "get Rules with no parameters supplied" {
 			$defaultRules = Get-ScriptAnalyzerRule
             $expectedNumRules = 45
-            if ((Test-PSEditionCoreClr))
+            if ((Test-PSEditionCoreClr) -or (Test-PSVersionV3))
             {
+                # for PSv3 PSAvoidGlobalAliases is not shipped because
+                # it uses StaticParameterBinder.BindCommand which is
+                # available only on PSv4 and above
+                # for PowerShell Core, PSUseSingularNouns is not
+                # shipped because it uses APIs that are not present
+                # in dotnet core.
                 $expectedNumRules = 44
             }
 			$defaultRules.Count | Should be $expectedNumRules

Tests/PSScriptAnalyzerTestHelper.psm1

@@ -38,6 +38,11 @@ Function Test-PSEditionCoreCLRLinux
     (Test-PSEditionCoreCLR) -and $IsLinux
 }
 
+Function Test-PSVersionV3
+{
+	$PSVersionTable.PSVersion.Major -eq 3
+}
+
 Function Get-Count
 {
 	Begin {$count = 0}
@@ -49,4 +54,5 @@ Export-ModuleMember -Function Get-ExtentText
 Export-ModuleMember -Function Test-CorrectionExtent
 Export-ModuleMember -Function Test-PSEditionCoreCLR
 Export-ModuleMember -Function Test-PSEditionCoreCLRLinux
+Export-ModuleMember -Function Test-PSVersionV3
 Export-ModuleMember -Function Get-Count

Tests/Rules/AvoidGlobalAliases.tests.ps1

@@ -1,9 +1,15 @@
-Import-Module PSScriptAnalyzer
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$testRootDirectory = Split-Path -Parent $directory
+Import-Module (Join-Path $testRootDirectory 'PSScriptAnalyzerTestHelper.psm1')
+if ((Test-PSVersionV3))
+{
+    return
+}
+
+Import-Module PSScriptAnalyzer
 
 $AvoidGlobalAliasesError = "Avoid creating aliases with a Global scope."
 $violationName = "PSAvoidGlobalAliases"
-
-$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
 $violations = Invoke-ScriptAnalyzer $directory\AvoidGlobalAliases.psm1 | Where-Object {$_.RuleName -eq $violationName}
 $noViolations = Invoke-ScriptAnalyzer $directory\AvoidGlobalAliasesNoViolations.ps1 | Where-Object {$_.RuleName -eq $violationName}