PowerShell/docs/clean-repos.md
2024-01-03 12:11:22 +01:00

104 lines
3.3 KiB
Markdown

*clean-repos.ps1*
================
This PowerShell script cleans all Git repositories in a folder from untracked files (including submodules).
Parameters
----------
```powershell
PS> ./clean-repos.ps1 [[-parentDir] <String>] [<CommonParameters>]
-parentDir <String>
Specifies the path to the parent folder (current working dir 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> ./clean-repos.ps1 C:\MyRepos
(1) Searching for Git executable... git version 2.40.1
(2) Checking parent folder 📂Repos... 28 subfolders found
(3/30) Cleaning 📂base256unicode...
...
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Cleans all Git repositories in a folder from untracked files
.DESCRIPTION
This PowerShell script cleans all Git repositories in a folder from untracked files (including submodules).
.PARAMETER parentDir
Specifies the path to the parent folder (current working dir by default)
.EXAMPLE
PS> ./clean-repos.ps1 C:\MyRepos
⏳ (1) Searching for Git executable... git version 2.40.1
⏳ (2) Checking parent folder 📂Repos... 28 subfolders found
⏳ (3/30) Cleaning 📂base256unicode...
...
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$parentDir = "$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" }
$parentDirName = (Get-Item "$ParentDir").Name
Write-Host "⏳ (2) Checking parent folder 📂$parentDirName... " -noNewline
if (-not(Test-Path "$ParentDir" -pathType container)) { throw "Can't access folder: $ParentDir" }
$folders = (Get-ChildItem "$ParentDir" -attributes Directory)
$numFolders = $folders.Count
Write-Host "$numFolders subfolders found"
[int]$Step = 2
foreach ($folder in $folders) {
$FolderName = (Get-Item "$folder").Name
$Step++
"⏳ ($Step/$($numFolders + 2)) Cleaning 📂$FolderName..."
& git -C "$folder" clean -xfd -f # force + recurse into dirs + don't use the standard ignore rules
if ($lastExitCode -ne "0") { throw "'git clean -xfd -f' failed with exit code $lastExitCode" }
& git -C "$folder" submodule foreach --recursive git clean -xfd -f
if ($lastExitCode -ne "0") { throw "'git clean -xfd -f' in submodules failed with exit code $lastExitCode" }
}
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Cleaned $numFolders Git repos under 📂$parentDirName 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-repos.ps1 as of 01/03/2024 12:10:45)*