extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-08-10 05:17:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated the manuals

Browse Source
This commit is contained in:
Markus Fleschutz
2024-08-15 09:51:46 +02:00
parent 654d1a18d0
commit e1ffab5509
633 changed files with 2120 additions and 973 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/clean-repo.md
View File

@ -7,10 +7,10 @@ NOTE: To be used with care! This cannot be undone!
Parameters
----------
```powershell
PS> ./clean-repo.ps1 [[-pathToRepo] <String>] [<CommonParameters>]
PS> ./clean-repo.ps1 [[-path] <String>] [<CommonParameters>]
-pathToRepo <String>
Specifies the file path to the local Git repository
-path <String>
Specifies the file path to the local Git repository (current working directory by default)
Required? false
Position? 1
@ -26,12 +26,12 @@ PS> ./clean-repo.ps1 [[-pathToRepo] <String>] [<CommonParameters>]
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
PS> ./clean-repo.ps1 C:\Repos\rust
⏳ (1/4) Searching for Git executable... git version 2.45.0
⏳ (2/4) Checking local repository... C:\Repos\rust
⏳ (3/4) Removing untracked files in repository...
⏳ (4/4) Removing untracked files in submodules...
✔️ Repo 📂rust is clean now (took 1s).
✔️ Cleaned up 📂rust repository in 2s.
```
@ -52,22 +52,22 @@ Script Content
.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 pathToRepo
Specifies the file path to the local Git repository
.PARAMETER path
Specifies the file path to the local Git repository (current working directory by default)
.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
PS> ./clean-repo.ps1 C:\Repos\rust
⏳ (1/4) Searching for Git executable... git version 2.45.0
⏳ (2/4) Checking local repository... C:\Repos\rust
⏳ (3/4) Removing untracked files in repository...
⏳ (4/4) Removing untracked files in submodules...
✔️ Repo 📂rust is clean now (took 1s).
✔️ Cleaned up 📂rust repository in 2s.
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$pathToRepo = "$PWD")
param([string]$path = "$PWD")
try {
$stopWatch = [system.diagnostics.stopwatch]::startNew()
@ -76,24 +76,24 @@ try {
& git --version
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
"⏳ (2/4) Checking local repository... 📂$pathToRepo"
if (-not(Test-Path "$pathToRepo" -pathType container)) { throw "Can't access repo folder '$pathToRepo' - maybe a typo or missing folder permissions?" }
$repoName = (Get-Item "$pathToRepo").Name
"⏳ (2/4) Checking local repository... $path"
if (-not(Test-Path "$path" -pathType container)) { throw "Can't access repo folder '$path' - maybe a typo or missing folder permissions?" }
$repoName = (Get-Item "$path").Name
"⏳ (3/4) Removing untracked files in repository..."
& git -C "$pathToRepo" clean -xfd -f # to delete all untracked files in the main repo
& git -C "$path" 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 "$pathToRepo" clean -xfd -f
& git -C "$path" clean -xfd -f
if ($lastExitCode -ne "0") { throw "'git clean' failed with exit code $lastExitCode" }
}
"⏳ (4/4) Removing untracked files in submodules..."
& git -C "$pathToRepo" submodule foreach --recursive git clean -xfd -f # to delete all untracked files in the submodules
& git -C "$path" 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
"✔️ Repo 📂$repoName is clean now (took $($elapsed)s)."
"✔️ Cleaned up 📂$repoName repository in $($elapsed)s."
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
@ -101,4 +101,4 @@ try {
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of clean-repo.ps1 as of 05/19/2024 10:25:18)*
*(generated by convert-ps2md.ps1 using the comment-based help of clean-repo.ps1 as of 08/15/2024 09:50:46)*