From 5381e88cede377f0fa29451230afb60a42d948c4 Mon Sep 17 00:00:00 2001
From: Markus Fleschutz <markus.fleschutz@atcsim.de>
Date: Thu, 22 Feb 2024 07:26:22 +0100
Subject: [PATCH] Update switch-branch.ps1

---
 scripts/switch-branch.ps1 | 46 +++++++++++++++++++--------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/scripts/switch-branch.ps1 b/scripts/switch-branch.ps1
index 6e1e4549..02acda03 100755
--- a/scripts/switch-branch.ps1
+++ b/scripts/switch-branch.ps1
@@ -2,15 +2,15 @@
 .SYNOPSIS
 	Switches the Git branch
 .DESCRIPTION
-	This PowerShell script switches to another branch in a Git repository (including submodules).
+	This PowerShell script switches to a given branch in a Git repository (including updating submodules).
 .PARAMETER branchName
-	Specifies the branch name
-.PARAMETER repoDir
-	Specifies the path to the local Git repository
+	Specifies the target branch name
+.PARAMETER pathToRepo
+	Specifies the file path to the local Git repository
 .EXAMPLE
 	PS> ./switch-branch main C:\MyRepo
-	⏳ (1/6) Searching for Git executable...   git version 2.42.0.windows.1
-	⏳ (2/6) Checking local repository...
+	⏳ (1/6) Searching for Git executable...   git version 2.43.0.windows.1
+	⏳ (2/6) Checking Git repository...
 	⏳ (3/6) Fetching updates...
 	⏳ (4/6) Switching to branch 'main'...
 	⏳ (5/6) Pulling updates...
@@ -22,44 +22,44 @@
 	Author: Markus Fleschutz | License: CC0
 #>
 
-param([string]$branchName = "", [string]$repoDir = "$PWD")
+param([string]$branchName = "", [string]$pathToRepo = "$PWD")
 
 try {
 	if ($branchName -eq "") { $branchName = Read-Host "Enter the branch name to switch to" }
-	if ($repoDir -eq "") { $repoDir = Read-Host "Enter the path to the local Git repository" }
+	if ($pathToRepo -eq "") { $pathToRepo = Read-Host "Enter the path to the local Git repository" }
 
-	$StopWatch = [system.diagnostics.stopwatch]::startNew()
+	$stopWatch = [system.diagnostics.stopwatch]::startNew()
 
 	Write-Host "⏳ (1/6) Searching for Git executable...   " -noNewline
 	& git --version
 	if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
 
-	Write-Host "⏳ (2/6) Checking local repository..."
-	$repoDir = Resolve-Path "$repoDir"
-	if (-not(Test-Path "$repoDir" -pathType container)) { throw "Can't access directory: $repoDir" }
-	$Result = (git status)
-	if ($lastExitCode -ne "0") { throw "'git status' in $repoDir failed with exit code $lastExitCode" }
-	if ("$Result" -notmatch "nothing to commit, working tree clean") { throw "Git repository is NOT clean: $Result" }
-	$repoDirName = (Get-Item "$repoDir").Name
+	Write-Host "⏳ (2/6) Checking Git repository..."
+	$pathToRepo = Resolve-Path "$pathToRepo"
+	if (-not(Test-Path "$pathToRepo" -pathType container)) { throw "Can't access directory: $pathToRepo" }
+	$result = (git status)
+	if ($lastExitCode -ne "0") { throw "'git status' in $pathToRepo failed with exit code $lastExitCode" }
+	if ("$result" -notmatch "nothing to commit, working tree clean") { throw "Git repository is NOT clean: $result" }
+	$pathToRepoName = (Get-Item "$pathToRepo").Name
 
-	"⏳ (3/6) Fetching latest updates..."
-	& git -C "$repoDir" fetch --all --prune --prune-tags --force
+	"⏳ (3/6) Fetching updates..."
+	& git -C "$pathToRepo" fetch --all --prune --prune-tags --force
 	if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
 
 	"⏳ (4/6) Switching to branch '$branchName'..."
-	& git -C "$repoDir" checkout --recurse-submodules "$branchName"
+	& git -C "$pathToRepo" checkout --recurse-submodules "$branchName"
 	if ($lastExitCode -ne "0") { throw "'git checkout $branchName' failed with exit code $lastExitCode" }
 
 	"⏳ (5/6) Pulling updates..."
-	& git -C "$repoDir" pull --recurse-submodules
+	& git -C "$pathToRepo" pull --recurse-submodules
 	if ($lastExitCode -ne "0") { throw "'git pull' failed with exit code $lastExitCode" }
 
 	"⏳ (6/6) Updating submodules..."	
-	& git -C "$repoDir" submodule update --init --recursive
+	& git -C "$pathToRepo" submodule update --init --recursive
 	if ($lastExitCode -ne "0") { throw "'git submodule update' failed with exit code $lastExitCode" }
 
-	[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
-	"✔️ Switched repo 📂$repoDirName to branch '$branchName' in $Elapsed sec"
+	[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
+	"✔️ Switched repo 📂$pathToRepoName to branch '$branchName' in $elapsed sec."
 	exit 0 # success
 } catch {
 	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"