PSScriptAnalyzer and VS Code tooling (#224)

This adds the following files:

* `launch.json` - used by vscode in order to debug PowerShellForGitHub with ease
* `PSScriptAnalyzerSettings.psd1` - used by PSSA to check syntax and also by VS Code to show problems for all rules

PSSA Rules: https://github.com/PowerShell/PSScriptAnalyzer/tree/master/RuleDocumentation
Specifically: https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/UseCompatibleSyntax.md

Author: TylerLeonhardt

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            // Run this launch config and then set breakpoints in your module.
+            // Then you can `Import-Module -Force ./PowerShellForGitHub.psd1`
+            // and run a function that will hit the breakpoint.
+            "name": "PowerShell: Interactive Session",
+            "type": "PowerShell",
+            "request": "launch",
+            "cwd": ""
+        }
+    ]
+}

CONTRIBUTING.md

@@ -153,7 +153,7 @@ Update-Module -Name PSScriptAnalyzer
 Once it's installed (or updated), from the root of your enlistment simply call
 
 ```powershell
-Invoke-ScriptAnalyzer -Path .\ -Recurse
+Invoke-ScriptAnalyzer -Settings ./PSScriptAnalyzerSettings.psd1 -Path ./ -Recurse
 ```
 
 That should return with no output.  If you see any output when calling that command,

PSScriptAnalyzerSettings.psd1

@@ -0,0 +1,19 @@
+# PSScriptAnalyzerSettings.psd1
+# Settings for PSScriptAnalyzer invocation.
+# All default rules are also enabled.
+@{
+    Rules = @{
+        PSUseCompatibleSyntax = @{
+            # This turns the rule on (setting it to false will turn it off)
+            Enable = $true
+
+            # Simply list the targeted versions of PowerShell here
+            TargetVersions = @(
+                '4.0',
+                '5.1',
+                '6.2',
+                '7.0'
+            )
+        }
+    }
+}

build/pipelines/templates/run-staticAnalysis.yaml

@@ -9,7 +9,7 @@ steps:
     displayName: 'Install PSScriptAnalyzer'
 
   - powershell: |
-       $results = try { Invoke-ScriptAnalyzer -Path ./ –Recurse -ErrorAction Stop } catch { $_.Exception.StackTrace; throw }
+       $results = try { Invoke-ScriptAnalyzer -Settings ./PSScriptAnalyzerSettings.psd1 -Path ./ –Recurse -ErrorAction Stop } catch { $_.Exception.StackTrace; throw }
        $results | ForEach-Object { Write-Host "##vso[task.logissue type=$($_.Severity);sourcepath=$($_.ScriptPath);linenumber=$($_.Line);columnnumber=$($_.Column);]$($_.Message)" }
 
        $null = New-Item -Path ..\ -Name ScriptAnalyzer -ItemType Directory -Force

build/scripts/ConvertTo-NUnitXml.ps1

@@ -16,7 +16,7 @@
         Overwrite the file at Path if it exists.
 
     .EXAMPLE
-        $results = Invoke-ScriptAnalyzer -Path ./ -Recurse
+        $results = Invoke-ScriptAnalyzer -Settings ./PSScriptAnalyzerSettings.psd1 -Path ./ -Recurse
         .\ConverTo-NUnitXml.ps1 -ScriptAnalyzerResult $results -Path ./PSScriptAnalyzerFailures.xml
 #>
 [CmdletBinding()]