Update the manuals in Docs/

Docs/check-repo.md

@@ -1,4 +1,4 @@
-## check-repo.ps1 - Checks a Git repository
+## The check-repo.ps1 PowerShell Script
 
 This PowerShell script verifies the integrity of a local Git repository.
 
@@ -32,4 +32,83 @@ Author: Markus Fleschutz | License: CC0
 ## Related Links
 https://github.com/fleschutz/PowerShell
 
+## Source Code
+<#
+.SYNOPSIS
+	Checks a Git repository
+.DESCRIPTION
+	This PowerShell script verifies the integrity of a local Git repository.
+.PARAMETER RepoDir
+	Specifies the path to the Git repository (current working dir by default)
+.EXAMPLE
+	PS> ./check-repo
+.LINK
+	https://github.com/fleschutz/PowerShell
+.NOTES
+	Author: Markus Fleschutz | License: CC0
+#>
+
+param([string]$RepoDir = "$PWD")
+
+try {
+	$StopWatch = [system.diagnostics.stopwatch]::startNew()
+
+	Write-Host "⏳ (1/11) 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/11) Checking path...                 " -noNewline
+	$FullPath = Resolve-Path "$RepoDir"
+	if (!(Test-Path "$FullPath" -pathType Container)) { throw "Can't access folder: $FullPath" }
+	"$FullPath"
+
+	Write-Host "⏳ (3/11) Searching for 📂.git...          " -noNewline
+	if (!(Test-Path "$FullPath/.git" -pathType container)) { throw "Can't access folder: $FullPath/.git" }
+	"OK"
+
+	Write-Host "⏳ (4/11) Query remote URL...              " -noNewline
+	& git -C "$FullPath" remote get-url origin
+	if ($lastExitCode -ne "0") { throw "'git remote get-url origin' failed with exit code $lastExitCode" }
+
+	Write-Host "⏳ (5/11) Query current branch...          " -noNewline
+	& git -C "$FullPath" branch --show-current
+	if ($lastExitCode -ne "0") { throw "'git branch --show-current' failed with exit code $lastExitCode" }
+
+	Write-Host "⏳ (6/11) Trying to fetch...               " -noNewline
+	& git -C "$FullPath" fetch
+	if ($lastExitCode -ne "0") { throw "'git branch --show-current' failed with exit code $lastExitCode" }
+	Write-Host "OK"
+
+	Write-Host "⏳ (7/11) Query latest tag...              " -noNewline
+        $LatestTagCommitID = (git -C "$FullPath" rev-list --tags --max-count=1)
+        $LatestTagName = (git -C "$FullPath" describe --tags $LatestTagCommitID)
+        Write-Host "$LatestTagName (commit $LatestTagCommitID)"
+
+	Write-Host "⏳ (8/11) Verify data integrity..."
+	& git -C "$FullPath" fsck 
+	if ($lastExitCode -ne "0") { throw "'git fsck' failed with exit code $lastExitCode" }
+
+	Write-Host "⏳ (9/11) Run maintenance tasks..."
+	& git -C "$FullPath" maintenance run
+	if ($lastExitCode -ne "0") { throw "'git maintenance run' failed with exit code $lastExitCode" }
+
+	Write-Host "⏳ (10/11) Query submodule status...        " -noNewline
+	& git -C "$FullPath" submodule status
+	if ($lastExitCode -ne "0") { throw "'git submodule status' failed with exit code $lastExitCode" }
+	" "
+
+	Write-Host "⏳ (11/11) Query repository status...      " -noNewline
+	& git -C "$FullPath" status --short 
+	if ($lastExitCode -ne "0") { throw "'git status --short' failed with exit code $lastExitCode" }
+	" "
+
+	$RepoDirName = (Get-Item "$FullPath").Name
+	[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
+	"✔️ checked 📂$RepoDirName repo in $Elapsed sec"
+	exit 0 # success
+} catch {
+	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
+	exit 1
+}
+
 *Generated by convert-ps2md.ps1 using the comment-based help of check-repo.ps1*