Merge pull request #617 from PowerShell/kapilmb/UseCompatibleCmdlets

Add rule to check cmdlet compatibility

Author: Kapil Borle

Engine/Helper.cs

@@ -806,7 +806,7 @@ public IScriptExtent GetScriptExtentForFunctionName(FunctionDefinitionAst functi
         /// <param name="set"></param>
         /// <param name="subset"></param>
         /// <returns>True or False</returns>
-        private bool ContainsExtent(IScriptExtent set, IScriptExtent subset)
+        public static bool ContainsExtent(IScriptExtent set, IScriptExtent subset)
         {
             if (set == null || subset == null)
             {

Engine/Settings/core-6.0.0-alpha-linux.json

@@ -2,7 +2,7 @@
   "name": "Microsoft.Windows.PowerShell.ScriptAnalyzer",
   "version": "1.7.0",
   "dependencies": {
-"System.Management.Automation": "1.0.0-alpha.9.4808"
+"System.Management.Automation": "1.0.0-alpha10"
     },
   "frameworks": {
     "net451": {

Engine/Settings/core-6.0.0-alpha-osx.json

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageRestore>
+    <add key="enabled" value="False" />
+    <add key="automatic" value="False" />
+  </packageRestore>
+  <activePackageSource>
+    <add key="nuget.org" value="https://www.nuget.org/api/v2/" />
+  </activePackageSource>
+  <packageSources>
+    <add key="nuget.org" value="https://www.nuget.org/api/v2/" />
+    <add key="powershell-core" value="https://powershell.myget.org/F/powershell-core/api/v3/index.json" />
+  </packageSources>
+  <bindingRedirects>
+    <add key="skip" value="False" />
+  </bindingRedirects>
+</configuration>

Engine/Settings/core-6.0.0-alpha-windows.json

@@ -45,4 +45,5 @@
 |[UseShouldProcessForStateChangingFunctions](./UseShouldProcessForStateChangingFunctions.md) | Warning|
 |[UseSingularNouns](./UseSingularNouns.md) | Warning|
 |[UseStandardDSCFunctionsInResource](./UseStandardDSCFunctionsInResource.md) | Error |
-|[UseToExportFieldsInManifest](./UseToExportFieldsInManifest.md) | Warning|
+|[UseToExportFieldsInManifest](./UseToExportFieldsInManifest.md) | Warning|
+|[UseCompatibleCmdlets](./UseCompatibleCmdlets.md) | Warning|

Engine/project.json

@@ -0,0 +1,16 @@
+# UseCompatibleCmdlets
+**Severity Level: Warning**
+
+## Description
+This rule flags cmdlets that are not available in a given Edition/Version of PowerShell on a given Operating System. It works by comparing a cmdlet against a set of whitelists which ship with PSScriptAnalyzer. They can be found at `/path/to/PSScriptAnalyzerModule/Settings`. These files are of the form, `PSEDITION-PSVERSION-OS.json` where `PSEDITION` can be either `core` or `desktop`, `OS` can be either `windows`, `linux` or `osx`, and `version` is the PowerShell version. To enable the rule to check if your script is compatible on PowerShell Core on windows, put the following your settings file:
+```PowerShell
+@{
+    'Rules' = @{
+        'PSUseCompatibleCmdlets' = @{
+            'compatibility' = @("core-6.0.0-alpha-windows")
+        }
+    }
+}
+```
+
+The parameter `compatibility` is a list that contain any of the following `{core-6.0.0-alpha-windows, core-6.0.0-alpha-linux, core-6.0.0-alpha-osx}`.

NuGet.Config

@@ -114,6 +114,7 @@
     <Compile Include="UseStandardDSCFunctionsInResource.cs" />
     <Compile Include="UseUTF8EncodingForHelpFile.cs" />
     <Compile Include="ReturnCorrectTypesForDSCFunctions.cs" />
+    <Compile Include="UseCompatibleCmdlets.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Engine\ScriptAnalyzerEngine.csproj">