mirror of
https://github.com/fleschutz/PowerShell.git
synced 2024-11-15 12:34:25 +01:00
89 lines
2.8 KiB
Markdown
89 lines
2.8 KiB
Markdown
## The *clean-repo.ps1* Script
|
|
|
|
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
|
|
/home/mf/Repos/PowerShell/Scripts/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 C:\MyRepo
|
|
|
|
```
|
|
|
|
## Notes
|
|
Author: Markus Fleschutz | License: CC0
|
|
|
|
## Related Links
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
## Source Code
|
|
```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 C:\MyRepo
|
|
.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 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 repo's untracked files..."
|
|
& 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 submodules' untracked files..."
|
|
& 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*
|