Rename folder Docs to docs

2025-08-15 07:12:44 +02:00 · 2023-10-31 11:05:01 +01:00
parent 0915de8f8b
commit 893273739a
900 changed files with 304 additions and 304 deletions
--- a/docs/clone-repos.md
+++ b/docs/clone-repos.md
@ -0,0 +1,122 @@
+*clone-repos.ps1*
+================
+
+This PowerShell script clones popular Git repositories into a target directory.
+
+Parameters
+----------
+```powershell
+PS> ./clone-repos.ps1 [[-TargetDir] <String>] [<CommonParameters>]
+
+-TargetDir <String>
+    Specifies the file path to the target directory (current working directory by default)
+    
+    Required?                    false
+    Position?                    1
+    Default value                "$PWD"
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
+
+[<CommonParameters>]
+    This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, 
+    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
+```
+
+Example
+-------
+```powershell
+PS> ./clone-repos C:\Repos
+⏳ (1) Searching for Git executable...          git version 2.41.0.windows.3
+⏳ (2) Reading Data/popular-repositories.csv... 28 repos
+⏳ (3) Checking target folder...                📂repos
+⏳ (4/32) Cloning into 📂base256unicode (dev tool)...
+...
+
+```
+
+Notes
+-----
+Author: Markus Fleschutz | License: CC0
+
+Related Links
+-------------
+https://github.com/fleschutz/PowerShell
+
+Script Content
+--------------
+```powershell
+<#
+.SYNOPSIS
+	Clones Git repos
+.DESCRIPTION
+	This PowerShell script clones popular Git repositories into a target directory.
+.PARAMETER targetDir
+	Specifies the file path to the target directory (current working directory by default)
+.EXAMPLE
+	PS> ./clone-repos C:\Repos
+	⏳ (1) Searching for Git executable...          git version 2.41.0.windows.3
+	⏳ (2) Reading Data/popular-repositories.csv... 28 repos
+	⏳ (3) Checking target folder...                📂repos
+	⏳ (4/32) Cloning into 📂base256unicode (dev tool)...
+	...
+.LINK
+	https://github.com/fleschutz/PowerShell
+.NOTES
+	Author: Markus Fleschutz | License: CC0
+#>
+
+param([string]$TargetDir = "$PWD")
+
+try {
+	$StopWatch = [system.diagnostics.stopwatch]::startNew()
+
+	Write-Host "⏳ (1) 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) Reading Data/popular-repositories.csv... " -noNewline
+	$Table = Import-CSV "$PSScriptRoot/../Data/popular-repositories.csv"
+	$NumEntries = $Table.count
+	Write-Host "$NumEntries repos"
+
+	$TargetDirName = (Get-Item "$TargetDir").Name
+	Write-Host "⏳ (3) Checking target folder...                📂$TargetDirName"
+	if (-not(Test-Path "$TargetDir" -pathType container)) { throw "Can't access directory: $TargetDir" }
+	
+	[int]$Step = 3
+	[int]$Cloned = 0
+	[int]$Skipped = 0
+	foreach($Row in $Table) {
+		[string]$FolderName = $Row.FOLDERNAME
+		[string]$Category = $Row.CATEGORY
+		[string]$Branch = $Row.BRANCH
+		[string]$Shallow = $Row.SHALLOW
+		[string]$URL = $Row.URL
+		$Step++
+
+		if (Test-Path "$TargetDir/$FolderName" -pathType container) {
+			"⏳ ($Step/$($NumEntries + 4)) Skipping existing 📂$FolderName ($Category)..."
+			$Skipped++
+			continue
+		}
+		if ($Shallow -eq "yes") {
+			"⏳ ($Step/$($NumEntries + 4)) Cloning into 📂$FolderName ($Category) - $Branch branch only..."
+			& git clone --branch "$Branch" --single-branch --recurse-submodules "$URL" "$TargetDir/$FolderName"
+			if ($lastExitCode -ne "0") { throw "'git clone --branch $Branch $URL' failed with exit code $lastExitCode" }
+		} else {
+			"⏳ ($Step/$($NumEntries + 4)) Cloning into 📂$FolderName ($Category) - $Branch branch with full history..."
+			& git clone --branch "$Branch" --recurse-submodules "$URL" "$TargetDir/$FolderName"
+			if ($lastExitCode -ne "0") { throw "'git clone --branch $Branch $URL' failed with exit code $lastExitCode" }
+		}
+		$Cloned++
+	}
+	[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
+	"✔️ Cloning $Cloned of $NumEntries Git repos into folder 📂$TargetDirName took $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 clone-repos.ps1 as of 10/19/2023 08:11:36)*