PowerShell/Docs/cd-repos.md

80 lines
2.1 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *cd-repos.ps1* Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script changes the working directory to the user's Git repositories folder.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2023-05-26 12:20:18 +02:00
/home/mf/Repos/PowerShell/Scripts/cd-repos.ps1 [[-Subpath] <String>] [<CommonParameters>]
2022-12-04 10:40:18 +01:00
-Subpath <String>
Specifies an additional relative subpath (optional)
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
2021-11-08 21:36:42 +01:00
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./cd-repos
2022-11-17 19:46:02 +01:00
📂C:\Users\Markus\Repos
2021-11-08 21:36:42 +01:00
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Sets the working directory to the user's repos folder
.DESCRIPTION
This PowerShell script changes the working directory to the user's Git repositories folder.
2022-12-04 10:40:18 +01:00
.PARAMETER Subpath
Specifies an additional relative subpath (optional)
2022-11-17 20:02:26 +01:00
.EXAMPLE
PS> ./cd-repos
📂C:\Users\Markus\Repos
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2022-12-04 10:40:18 +01:00
param([string]$Subpath = "")
2022-11-17 20:02:26 +01:00
try {
2022-12-04 10:40:18 +01:00
if (Test-Path "$HOME/Repos" -pathType Container) { # try short name
$Path = "$HOME/Repos/$Subpath"
} elseif (Test-Path "$HOME/Repositories" -pathType Container) { # try long name
$Path = "$HOME/Repositories/$Subpath"
} elseif (Test-Path "$HOME/source/repos" -pathType Container) { # try Visual Studio default
$Path = "$HOME/source/repos/$Subpath"
2022-11-17 20:02:26 +01:00
} else {
2023-05-26 12:20:18 +02:00
throw "The folder for Git repositories in your home directory doesn't exist (yet)."
2022-12-04 10:40:18 +01:00
}
if (-not(Test-Path "$Path" -pathType Container)) {
throw "The path to 📂$Path doesn't exist (yet)."
2022-11-17 20:02:26 +01:00
}
2022-12-04 10:40:18 +01:00
$Path = Resolve-Path "$Path"
2022-11-17 20:02:26 +01:00
Set-Location "$Path"
"📂$Path"
exit 0 # success
} catch {
2022-12-04 10:40:18 +01:00
"⚠️ Error: $($Error[0])"
2022-11-17 20:02:26 +01:00
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of cd-repos.ps1*