Rename folder Docs to docs

2025-08-09 13:04:59 +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/clean-repo.md
+++ b/docs/clean-repo.md
@ -0,0 +1,104 @@
+*clean-repo.ps1*
+================
+
+This PowerShell script deletes all untracked files and folders in a local Git repository (including submodules).
+NOTE: To be used with care! This cannot be undone!
+
+Parameters
+----------
+```powershell
+PS> ./clean-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
+
+-RepoDir <String>
+    Specifies the file path to the local Git repository
+    
+    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> ./clean-repo.ps1 C:\rust
+⏳ (1/4) Searching for Git executable...          git version 2.41.0.windows.3
+⏳ (2/4) Checking local repository...        	  📂C:\rust
+⏳ (3/4) Removing untracked files in repository...
+⏳ (4/4) Removing untracked files in submodules...
+✔️ Cleaned repo 📂rust in 1 sec
+
+```
+
+Notes
+-----
+Author: Markus Fleschutz | License: CC0
+
+Related Links
+-------------
+https://github.com/fleschutz/PowerShell
+
+Script Content
+--------------
+```powershell
+<#
+.SYNOPSIS
+	Cleans a repo
+.DESCRIPTION
+	This PowerShell script deletes all untracked files and folders in a local Git repository (including submodules).
+	NOTE: To be used with care! This cannot be undone!
+.PARAMETER RepoDir
+	Specifies the file path to the local Git repository
+.EXAMPLE
+	PS> ./clean-repo.ps1 C:\rust
+	⏳ (1/4) Searching for Git executable...          git version 2.41.0.windows.3
+	⏳ (2/4) Checking local repository...        	  📂C:\rust
+	⏳ (3/4) Removing untracked files in repository...
+	⏳ (4/4) Removing untracked files in submodules...
+	✔️ Cleaned repo 📂rust in 1 sec
+.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/4) Searching for Git executable...          " -noNewline
+	& git --version
+	if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
+
+	"⏳ (2/4) Checking local repository...             📂$RepoDir"
+	if (-not(Test-Path "$RepoDir" -pathType container)) { throw "Can't access folder '$RepoDir' - maybe a typo or missing folder permissions?" }
+	$RepoDirName = (Get-Item "$RepoDir").Name
+
+	"⏳ (3/4) Removing untracked files in repository..."
+	& git -C "$RepoDir" clean -xfd -f # to delete all untracked files in the main repo
+	if ($lastExitCode -ne "0") {
+		Write-Warning "'git clean' failed with exit code $lastExitCode, retrying once..."
+		& git -C "$RepoDir" clean -xfd -f 
+		if ($lastExitCode -ne "0") { throw "'git clean' failed with exit code $lastExitCode" }
+	}
+
+	"⏳ (4/4) Removing untracked files in submodules..."
+	& git -C "$RepoDir" submodule foreach --recursive git clean -xfd -f # to delete all untracked files in the submodules
+	if ($lastExitCode -ne "0") { throw "'git clean' in the submodules failed with exit code $lastExitCode" }
+
+	[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
+	"✔️ Cleaned repo 📂$RepoDirName 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 clean-repo.ps1 as of 10/19/2023 08:11:36)*