Merge pull request #783 from dahlbyk/rkeithhill/cleanup-pssa-warnings…

…-strictmode-errs

Enables strict mode testing of module, fix git restore --source= tab bug

PSScriptAnalyzerSettings.psd1

@@ -17,7 +17,7 @@
     # Use ExcludeRules when you want to run most of the default set of rules except
     # for a few rules you wish to "exclude".  Note: if a rule is in both IncludeRules
     # and ExcludeRules, the rule will be excluded.
-    ExcludeRules = @('PSAvoidUsingWriteHost', 'PSAvoidGlobalVars', 'PSAvoidUsingInvokeExpression')
+    ExcludeRules = @('PSAvoidUsingWriteHost', 'PSAvoidGlobalVars', 'PSAvoidUsingInvokeExpression', 'PSReviewUnusedParameter')
 
     # You can use the following entry to supply parameters to rules that take parameters.
     # For instance, the PSAvoidUsingCmdletAliases rule takes a whitelist for aliases you

src/GitTabExpansion.ps1

@@ -151,7 +151,7 @@ function script:gitFeatures($filter, $command) {
     $branches = @(git branch --no-color | ForEach-Object { if ($_ -match "^\*?\s*$featurePrefix(?<ref>.*)") { $matches['ref'] } })
     $branches |
         Where-Object { $_ -ne '(no branch)' -and $_ -like "$filter*" } |
-        ForEach-Object { $prefix + $_ } |
+        ForEach-Object { $featurePrefix + $_ } |
         quoteStringWithSpecialChars
 }
 
@@ -390,9 +390,9 @@ function GitTabExpansionInternal($lastBlock, $GitStatus = $null) {
             gitCheckoutFiles $GitStatus $matches['files']
         }
 
-        # Handles git restore -s <ref> - must come before the next regex case
-        "^restore.* (?-i)-s\s*(?<ref>\S*)$" {
-            gitBranches $matches['ref'] $true
+        # Handles git restore -s <ref> / --source=<ref> - must come before the next regex case
+        "^restore.* (?-i)(-s\s*|(?<source>--source=))(?<ref>\S*)$" {
+            gitBranches $matches['ref'] $true $matches['source']
             gitTags $matches['ref']
             break
         }

src/GitUtils.ps1

@@ -153,9 +153,11 @@ function Get-GitBranch($gitDir = $(Get-GitDirectory), [Diagnostics.Stopwatch]$sw
         }
 
         dbg 'Inside git directory?' $sw
-        if ('true' -eq $(git rev-parse --is-inside-git-dir 2>$null)) {
+        $revParseOut = git rev-parse --is-inside-git-dir 2>$null
+        if ('true' -eq $revParseOut) {
             dbg 'Inside git directory' $sw
-            if ('true' -eq $(git rev-parse --is-bare-repository 2>$null)) {
+            $revParseOut = git rev-parse --is-bare-repository 2>$null
+            if ('true' -eq $revParseOut) {
                 $c = 'BARE:'
             }
             else {
@@ -251,6 +253,8 @@ function Get-GitStatus {
         $aheadBy = 0
         $behindBy = 0
         $gone = $false
+        $upstream = $null
+
         $indexAdded = New-Object System.Collections.Generic.List[string]
         $indexModified = New-Object System.Collections.Generic.List[string]
         $indexDeleted = New-Object System.Collections.Generic.List[string]
@@ -317,7 +321,7 @@ function Get-GitStatus {
                 switch ($settings.UntrackedFilesMode) {
                     "No"      { $untrackedFilesOption = "-uno" }
                     "All"     { $untrackedFilesOption = "-uall" }
-                    "Normal"  { $untrackedFilesOption = "-unormal" }
+                    default   { $untrackedFilesOption = "-unormal" }
                 }
                 $status = Invoke-Utf8ConsoleCommand { git -c core.quotepath=false -c color.status=false status $untrackedFilesOption --short --branch 2>$null }
                 if ($settings.EnableStashStatus) {

src/posh-git.psm1

@@ -1,5 +1,10 @@
 param([bool]$ForcePoshGitPrompt, [bool]$UseLegacyTabExpansion)
 
+if (Test-Path Env:\POSHGIT_ENABLE_STRICTMODE) {
+    # Set strict mode to latest to help catch scripting errors in the module. This is done by the Pester tests.
+    Set-StrictMode -Version Latest
+}
+
 . $PSScriptRoot\CheckRequirements.ps1 > $null
 
 . $PSScriptRoot\ConsoleMode.ps1
@@ -16,8 +21,8 @@ param([bool]$ForcePoshGitPrompt, [bool]$UseLegacyTabExpansion)
 $IsAdmin = Test-Administrator
 
 # Get the default prompt definition.
-$initialSessionState = [Runspace]::DefaultRunspace.InitialSessionState
-if (!$initialSessionState.Commands -or !$initialSessionState.Commands['prompt']) {
+$initialSessionState = [System.Management.Automation.Runspaces.Runspace]::DefaultRunspace.InitialSessionState
+if (!$initialSessionState -or !$initialSessionState.PSObject.Properties.Match('Commands') -or !$initialSessionState.Commands['prompt']) {
     $defaultPromptDef = "`$(if (test-path variable:/PSDebugContext) { '[DBG]: ' } else { '' }) + 'PS ' + `$(Get-Location) + `$(if (`$nestedpromptlevel -ge 1) { '>>' }) + '> '"
 }
 else {

test/Shared.ps1

@@ -1,8 +1,23 @@
+# Define these variables since they are not defined in WinPS 5.x
+if ($PSVersionTable.PSVersion.Major -lt 6) {
+    [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')]
+    $IsWindows = $true
+    [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')]
+    $IsLinux = $false
+    [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')]
+    $IsMacOS = $false
+}
+
 $modulePath = Convert-Path $PSScriptRoot\..\src
 $moduleManifestPath = "$modulePath\posh-git.psd1"
 
+[System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')]
 $csi = [char]0x1b + "["
+
+[System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')]
 $expectedEncoding = if ($PSVersionTable.PSVersion.Major -le 5) { "utf8" } else { "ascii" }
+
+[System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseDeclaredVarsMoreThanAssigments', '')]
 $originalTitle = $Host.UI.RawUI.WindowTitle
 
 if (!(Get-Variable -Name gitbin -Scope global -ErrorAction SilentlyContinue)) {
@@ -137,7 +152,9 @@ function ResetGitTempRepoWorkingDir($RepoPath, $Branch = 'master') {
 Remove-Item Function:\prompt
 Remove-Module posh-git -Force *>$null
 
-# Force the posh-git prompt to be installed. Could be runnng on dev system where
-# user has customized the prompt.
+# For Pester testing, enable strict mode inside the posh-git module
+$env:POSHGIT_ENABLE_STRICTMODE = 1
+
+# Force the posh-git prompt to be installed. Could be runnng on dev system where user has customized the prompt.
 [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssigments', '')]
 $module = Import-Module $moduleManifestPath -ArgumentList $true,$false -Force -PassThru