Merge pull request #40 from StartAutomating/CheckoutSupportAndFixes

CheckoutSupportAndFixes

Author: StartAutomating

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.8:
+* Adding Support for git checkout (#38)
+* Use-Git:  Avoiding unwanted confirmation ( Fixing #39 )
+---
+
 ## 0.1.7:
 * Use-Git: -Verbose no longer infers --verbose (#10)
 * Out-Git: Support for extension caching (#35)
@@ -43,4 +48,4 @@
 ---
 ## 0.1
 * Initial Release of ugit
----
+---

Extensions/Git.Checkout.UGit.Extension.ps1

@@ -0,0 +1,65 @@
+<#
+.SYNOPSIS
+    git checkout extension
+.DESCRIPTION
+    Outputs git checkout as objects.
+.EXAMPLE
+    git checkout -b CreateNewBranch
+.EXAMPLE
+    git checkout main
+#>
+[Management.Automation.Cmdlet('Out', 'Git')]
+[ValidatePattern('^git checkout')]
+param()
+
+begin {
+    $gitCheckoutLines = @()
+}
+
+process {
+    $gitCheckoutLines += $gitOut
+}
+
+end {
+    
+    if ($($gitCheckoutLines) -match "^Switched to a new branch '(?<b>[^']+)'") {
+        [PSCustomObject]@{
+            BranchName = $matches.b
+            PSTypeName = 'git.checkout.newbranch'
+            GitRoot    = $GitRoot
+        }
+    } 
+    elseif ($gitCheckoutLines -match "Switched to branch '(?<b>[^']+)'") 
+    {
+        $gitCheckoutInfo = @{PSTypeName='git.checkout.switchbranch';GitRoot=$GitRoot;GitOutputLines=$gitCheckoutLines;Modified=@()}
+        foreach ($checkoutLine in $gitCheckoutLines) {
+            if ($checkoutLine -match "Switched to branch '(?<b>[^']+)'") {
+                $gitCheckoutInfo.BranchName = $matches.b
+            }
+            elseif ($checkoutLine -match '^Your branch') {
+                $gitCheckoutInfo.Status = $checkoutLine
+            }
+            elseif ($checkoutLine -match '^(?<ct>\w)\s+(?<fn>\S+)') {                
+                if ($matches.ct -eq 'M') {
+                    $gitCheckoutInfo.modified += (Get-Item $matches.fn -ErrorAction SilentlyContinue)
+                }                
+            }
+        }
+        [PSCustomObject]$gitCheckoutInfo
+    }
+    elseif ($gitCheckoutLines -match "Already on '(?<b>[^']+)'") {
+        $gitCheckoutInfo = @{PSTypeName='git.checkout.alreadyonbranch';GitRoot=$GitRoot;GitOutputLines=$gitCheckoutLines}
+        foreach ($checkoutLine in $gitCheckoutLines) {
+            if ($checkoutLine -match "Already on '(?<b>[^']+)'") {
+                $gitCheckoutInfo.BranchName = $matches.b
+            }
+            elseif ($checkoutLine -match '^Your branch') {
+                $gitCheckoutInfo.Status = $checkoutLine
+            }            
+        }
+        [PSCustomObject]$gitCheckoutInfo
+    }
+    else {
+        $gitCheckoutLines
+    }
+}

Formatting/Git.Checkout.format.ps1

@@ -0,0 +1,27 @@
+Write-FormatView -TypeName git.checkout.newbranch -Action {
+    Write-FormatViewExpression -Text "Switched to a new branch "
+    Write-FormatViewExpression -ScriptBlock {"'$($_.BranchName)'"} -ForegroundColor verbose 
+} -GroupByProperty GitRoot
+
+Write-FormatView -TypeName git.checkout.alreadyonbranch -Action {
+    Write-FormatViewExpression -Text "Already on "
+    Write-FormatViewExpression -ScriptBlock {"'$($_.BranchName)'"} -ForegroundColor warning -If { $_.BranchName -in 'main', 'master'}
+    Write-FormatViewExpression -ScriptBlock {"'$($_.BranchName)'"} -ForegroundColor verbose -If { $_.BranchName -notin 'main', 'master'}
+    Write-FormatViewExpression -Newline
+    Write-FormatViewExpression -Property Status
+} -GroupByProperty GitRoot
+
+Write-FormatView -TypeName git.checkout.switchbranch -Action {
+    Write-FormatViewExpression -Text "Switched to "
+    Write-FormatViewExpression -ScriptBlock {"'$($_.BranchName)'"} -ForegroundColor warning -If { $_.BranchName -in 'main', 'master'}
+    Write-FormatViewExpression -ScriptBlock {"'$($_.BranchName)'"} -ForegroundColor verbose -If { $_.BranchName -notin 'main', 'master'}
+    Write-FormatViewExpression -Newline
+    Write-FormatViewExpression -Property Status
+    Write-FormatViewExpression -If { $_.Modified } -ScriptBlock {
+        @(
+            "  Untracked modifications:"
+            ""
+            $($_.Modified | Out-String).Trim()
+        ) -join [Environment]::NewLine
+    }
+} -GroupByProperty GitRoot

README.md

@@ -62,15 +62,16 @@ Get-UGitExtension is built using [Piecemeal](https://github.com/StartAutomating/
 ## Git Commands Extended
 
 * git branch
-* git commit
+* git checkout
 * git clone
+* git commit
 * git diff
 * git log
+* git pull
 * git push
 * git pull
 * git status
 
-
 ### Extensions that may apply to any git command:
 
 * git.fileoutput

Use-Git.ps1

@@ -83,6 +83,9 @@
                     $GitArgument[($argumentNumber + 1)..($GitArgument.Length - 1)]
                 })
                 $GitArgument = @($beforeArgs) + @("$($commandElement.Extent)") + @($afterArgs)
+                if ($commandElement.parameterName -eq 'd') { # Also, if they passed -d/-D, they probably don't want to be confirmed
+                    $ConfirmPreference ='none' # so set confirm impact to none
+                }
             }
             $argumentNumber++
         }
@@ -114,6 +117,10 @@
         # git sometimes like to return information along standard error, and CI/CD and user defaults sometimes set $ErrorActionPreference to 'Stop'
         # So we change $ErrorActionPreference before we call git, just in case.
         $ErrorActionPreference = 'continue'
+
+        # Before we process each directory, make a copy of the bound parameters.
+        $paramCopy = ([Ordered]@{} + $PSBoundParameters)
+
 
         # Now, we will force there to be at least one directory (the current path).
         # This makes the code simpler, because we are always going thru a loop.
@@ -124,7 +131,6 @@
             $directories = @(foreach ($dir in $directories) { $dir.Fullname }) 
         }
 
-        
 
         # For each directory we know of, we
         foreach ($dir in $directories) {
@@ -148,14 +154,16 @@
                     continue # and continue to the next one.
                 }
             }
-            
+                        
             $OutGitParams.GitRoot = "$($script:RepoRoots[$dir])"
             Write-Verbose "Calling git with $AllGitArgs"
             if ($dirCount -gt 1) {                
                 Write-Progress -PercentComplete (($dirCount * 5) % 100) -Status "git $allGitArgs " -Activity "$($dir) " -Id $progId
             }
 
-            if ($PSCmdlet.ShouldProcess("$pwd : git $allGitArgs")) {
+            if (($ConfirmPreference -eq 'None' -and -not $paramCopy.Confirm) -or # If we have indicated we do not care about -Confirmation, don't prompt
+                $PSCmdlet.ShouldProcess("$pwd : git $allGitArgs") # otherwise, as for confirmation to run.
+            ) {
                 & $script:CachedGitCmd @AllGitArgs *>&1       | # Then we run git, combining all streams into output.
                                                                 # then pipe to Out-Git, which will
                     Out-Git @OutGitParams # output git as objects.
@@ -165,9 +173,7 @@
                     # If Out-Git finds one or more extensions to run, these can parse the output.
             }
             Pop-Location # After we have run, Pop back out of the location.
-        }
-
-        
+        }        
     }
 
     end {