PowerShell/Scripts/clean-repo.ps1

54 lines
2.1 KiB
PowerShell
Raw Normal View History

2021-09-27 10:38:12 +02:00
<#
2021-07-13 21:10:02 +02:00
.SYNOPSIS
Cleans a repo
2021-07-13 21:10:02 +02:00
.DESCRIPTION
This PowerShell script deletes all untracked files and folders in a local Git repository (including submodules).
2022-04-13 10:47:53 +02:00
NOTE: To be used with care! This cannot be undone!
2021-10-16 16:50:10 +02:00
.PARAMETER RepoDir
Specifies the file path to the local Git repository
2021-07-13 21:10:02 +02:00
.EXAMPLE
2023-08-21 15:46:57 +02:00
PS> ./clean-repo.ps1 C:\rust
2023-08-06 21:35:36 +02:00
(1/4) Searching for Git executable... git version 2.41.0.windows.3
2023-08-21 15:46:57 +02:00
(2/4) Checking local repository... 📂C:\rust
2023-08-06 21:35:36 +02:00
(3/4) Removing untracked files in repository...
(4/4) Removing untracked files in submodules...
2023-09-01 09:49:00 +02:00
Cleaned repo 📂rust in 1 sec
2021-07-13 21:10:02 +02:00
.LINK
https://github.com/fleschutz/PowerShell
2022-01-29 12:47:46 +01:00
.NOTES
2022-03-28 16:25:24 +02:00
Author: Markus Fleschutz | License: CC0
2021-02-15 16:54:38 +01:00
#>
2021-07-15 15:51:22 +02:00
param([string]$RepoDir = "$PWD")
2021-02-28 18:26:20 +01:00
2021-02-15 16:54:38 +01:00
try {
2021-05-19 07:33:57 +02:00
$StopWatch = [system.diagnostics.stopwatch]::startNew()
2023-06-21 16:35:13 +02:00
Write-Host "⏳ (1/4) Searching for Git executable... " -noNewline
2022-08-11 11:56:14 +02:00
& git --version
2021-03-24 11:45:30 +01:00
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
2022-02-28 10:57:50 +01:00
2023-06-21 16:35:13 +02:00
"⏳ (2/4) Checking local repository... 📂$RepoDir"
2023-04-06 09:45:48 +02:00
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
2023-06-21 16:35:13 +02:00
"⏳ (3/4) Removing untracked files in repository..."
2022-04-04 16:15:29 +02:00
& git -C "$RepoDir" clean -xfd -f # to delete all untracked files in the main repo
2022-04-27 11:11:20 +02:00
if ($lastExitCode -ne "0") {
2023-03-01 10:52:37 +01:00
Write-Warning "'git clean' failed with exit code $lastExitCode, retrying once..."
2022-04-27 11:11:20 +02:00
& git -C "$RepoDir" clean -xfd -f
if ($lastExitCode -ne "0") { throw "'git clean' failed with exit code $lastExitCode" }
}
2021-02-15 16:54:38 +01:00
2023-06-21 16:35:13 +02:00
"⏳ (4/4) Removing untracked files in submodules..."
2022-04-04 16:15:29 +02:00
& 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" }
2021-02-15 16:54:38 +01:00
2021-05-19 07:33:57 +02:00
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
2023-09-01 09:49:00 +02:00
"✔️ Cleaned repo 📂$RepoDirName in $Elapsed sec"
2021-09-27 10:09:45 +02:00
exit 0 # success
2021-02-15 16:54:38 +01:00
} catch {
2022-04-13 12:06:32 +02:00
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
2021-02-15 16:54:38 +01:00
exit 1
2023-07-30 21:31:37 +02:00
}