mirror of
https://github.com/fleschutz/PowerShell.git
synced 2024-11-24 17:03:45 +01:00
105 lines
3.5 KiB
Markdown
105 lines
3.5 KiB
Markdown
Script: *clean-repo.ps1*
|
||
========================
|
||
|
||
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
|
||
PS> ./clean-repo.ps1 [[-pathToRepo] <String>] [<CommonParameters>]
|
||
|
||
-pathToRepo <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.ps1 C:\rust
|
||
⏳ (1/4) Searching for Git executable... git version 2.41.0.windows.3
|
||
⏳ (2/4) Checking local repository... 📂C:\rust
|
||
⏳ (3/4) Removing untracked files in repository...
|
||
⏳ (4/4) Removing untracked files in submodules...
|
||
✔️ Repo 📂rust is clean now (took 1s).
|
||
|
||
```
|
||
|
||
Notes
|
||
-----
|
||
Author: Markus Fleschutz | License: CC0
|
||
|
||
Related Links
|
||
-------------
|
||
https://github.com/fleschutz/PowerShell
|
||
|
||
Script Content
|
||
--------------
|
||
```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 pathToRepo
|
||
Specifies the file path to the local Git repository
|
||
.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
|
||
⏳ (3/4) Removing untracked files in repository...
|
||
⏳ (4/4) Removing untracked files in submodules...
|
||
✔️ Repo 📂rust is clean now (took 1s).
|
||
.LINK
|
||
https://github.com/fleschutz/PowerShell
|
||
.NOTES
|
||
Author: Markus Fleschutz | License: CC0
|
||
#>
|
||
|
||
param([string]$pathToRepo = "$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 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
|
||
|
||
"⏳ (3/4) Removing untracked files in repository..."
|
||
& git -C "$pathToRepo" 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
|
||
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
|
||
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)."
|
||
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 as of 05/19/2024 10:25:18)*
|