2024-11-08 12:38:20 +01:00
|
|
|
The *clean-repo.ps1* Script
|
|
|
|
===========================
|
2021-11-08 21:36:42 +01:00
|
|
|
|
2023-05-26 12:20:18 +02:00
|
|
|
This PowerShell script deletes all untracked files and folders in a local Git repository (including submodules).
|
2022-11-17 19:46:02 +01:00
|
|
|
NOTE: To be used with care! This cannot be undone!
|
2021-11-08 21:36:42 +01:00
|
|
|
|
2023-07-29 10:04:38 +02:00
|
|
|
Parameters
|
|
|
|
----------
|
2021-11-08 21:36:42 +01:00
|
|
|
```powershell
|
2024-11-08 12:35:11 +01:00
|
|
|
/home/markus/Repos/PowerShell/scripts/clean-repo.ps1 [[-path] <String>] [<CommonParameters>]
|
2021-11-08 21:36:42 +01:00
|
|
|
|
2024-08-15 09:51:46 +02:00
|
|
|
-path <String>
|
|
|
|
Specifies the file path to the local Git repository (current working directory by default)
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
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.
|
|
|
|
```
|
|
|
|
|
2023-07-29 10:04:38 +02:00
|
|
|
Example
|
|
|
|
-------
|
2021-11-08 21:36:42 +01:00
|
|
|
```powershell
|
2024-08-15 09:51:46 +02:00
|
|
|
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
|
2023-08-06 21:36:33 +02:00
|
|
|
⏳ (3/4) Removing untracked files in repository...
|
|
|
|
⏳ (4/4) Removing untracked files in submodules...
|
2024-11-08 12:35:11 +01:00
|
|
|
✅ Cleaned up 📂rust repo in 2s.
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
```
|
|
|
|
|
2023-07-29 10:04:38 +02:00
|
|
|
Notes
|
|
|
|
-----
|
2022-11-17 19:46:02 +01:00
|
|
|
Author: Markus Fleschutz | License: CC0
|
2021-11-08 21:36:42 +01:00
|
|
|
|
2023-07-29 10:04:38 +02:00
|
|
|
Related Links
|
|
|
|
-------------
|
2021-11-08 21:36:42 +01:00
|
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
|
2023-07-29 10:04:38 +02:00
|
|
|
Script Content
|
|
|
|
--------------
|
2022-11-17 20:05:34 +01:00
|
|
|
```powershell
|
2022-11-17 20:02:26 +01:00
|
|
|
<#
|
|
|
|
.SYNOPSIS
|
2023-05-26 12:20:18 +02:00
|
|
|
Cleans a repo
|
2022-11-17 20:02:26 +01:00
|
|
|
.DESCRIPTION
|
2023-05-26 12:20:18 +02:00
|
|
|
This PowerShell script deletes all untracked files and folders in a local Git repository (including submodules).
|
2022-11-17 20:02:26 +01:00
|
|
|
NOTE: To be used with care! This cannot be undone!
|
2024-08-15 09:51:46 +02:00
|
|
|
.PARAMETER path
|
|
|
|
Specifies the file path to the local Git repository (current working directory by default)
|
2022-11-17 20:02:26 +01:00
|
|
|
.EXAMPLE
|
2024-08-15 09:51:46 +02:00
|
|
|
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
|
2023-08-06 21:36:33 +02:00
|
|
|
⏳ (3/4) Removing untracked files in repository...
|
|
|
|
⏳ (4/4) Removing untracked files in submodules...
|
2024-11-08 12:35:11 +01:00
|
|
|
✅ Cleaned up 📂rust repo in 2s.
|
2022-11-17 20:02:26 +01:00
|
|
|
.LINK
|
|
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
.NOTES
|
|
|
|
Author: Markus Fleschutz | License: CC0
|
|
|
|
#>
|
|
|
|
|
2024-08-15 09:51:46 +02:00
|
|
|
param([string]$path = "$PWD")
|
2022-11-17 20:02:26 +01:00
|
|
|
|
|
|
|
try {
|
2024-03-27 17:36:59 +01:00
|
|
|
$stopWatch = [system.diagnostics.stopwatch]::startNew()
|
2022-11-17 20:02:26 +01:00
|
|
|
|
2023-07-29 09:45:37 +02:00
|
|
|
Write-Host "⏳ (1/4) Searching for Git executable... " -noNewline
|
2022-11-17 20:02:26 +01:00
|
|
|
& git --version
|
|
|
|
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
|
|
|
|
|
2024-08-15 09:51:46 +02:00
|
|
|
"⏳ (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
|
2022-11-17 20:02:26 +01:00
|
|
|
|
2023-07-29 09:45:37 +02:00
|
|
|
"⏳ (3/4) Removing untracked files in repository..."
|
2024-08-15 09:51:46 +02:00
|
|
|
& git -C "$path" clean -xfd -f # to delete all untracked files in the main repo
|
2022-11-17 20:02:26 +01:00
|
|
|
if ($lastExitCode -ne "0") {
|
2023-05-26 12:20:18 +02:00
|
|
|
Write-Warning "'git clean' failed with exit code $lastExitCode, retrying once..."
|
2024-08-15 09:51:46 +02:00
|
|
|
& git -C "$path" clean -xfd -f
|
2022-11-17 20:02:26 +01:00
|
|
|
if ($lastExitCode -ne "0") { throw "'git clean' failed with exit code $lastExitCode" }
|
|
|
|
}
|
|
|
|
|
2023-07-29 09:45:37 +02:00
|
|
|
"⏳ (4/4) Removing untracked files in submodules..."
|
2024-08-15 09:51:46 +02:00
|
|
|
& git -C "$path" submodule foreach --recursive git clean -xfd -f # to delete all untracked files in the submodules
|
2022-11-17 20:02:26 +01:00
|
|
|
if ($lastExitCode -ne "0") { throw "'git clean' in the submodules failed with exit code $lastExitCode" }
|
|
|
|
|
2024-03-27 17:36:59 +01:00
|
|
|
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
|
2024-11-08 12:35:11 +01:00
|
|
|
"✅ Cleaned up 📂$repoName repo in $($elapsed)s."
|
2022-11-17 20:02:26 +01:00
|
|
|
exit 0 # success
|
|
|
|
} catch {
|
|
|
|
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
|
|
|
exit 1
|
|
|
|
}
|
2022-11-17 20:05:34 +01:00
|
|
|
```
|
2022-11-17 20:02:26 +01:00
|
|
|
|
2024-11-20 11:52:20 +01:00
|
|
|
*(generated by convert-ps2md.ps1 as of 11/20/2024 11:51:52)*
|