Functions/GenXdev.Git/Add-IssueLineToREADME.ps1
|
############################################################################### <# .SYNOPSIS Adds an issue item to the README.md file. .DESCRIPTION Adds a timestamped issue to the "## Issues" section of a README.md file. Can display the modified section and open in Visual Studio Code. .PARAMETER Line The issue text to add. Will be prefixed with current date if not empty. .PARAMETER Code Opens the README in Visual Studio Code after modification. .PARAMETER Show Displays the modified section after changes. .PARAMETER UseHomeREADME Uses README in PowerShell profile directory instead of current location. .PARAMETER UseOneDriveREADME Uses README in OneDrive directory instead of current location. .EXAMPLE Add-IssueLineToREADME -Line "Found critical bug" -Show -UseHomeREADME .EXAMPLE issue "Server connection fails" -Show #> function Add-IssueLineToREADME { [CmdletBinding()] [Alias("issue")] param( ####################################################################### [Parameter( Position = 0, Mandatory = $false, ValueFromRemainingArguments = $true, HelpMessage = "The issue text to add" )] [AllowEmptyString()] [string] $Line = "", ####################################################################### [Parameter( Mandatory = $false, HelpMessage = "Open README in Visual Studio Code" )] [switch] $Code, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = "Show the modified section" )] [switch] $Show, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = "Use README in PowerShell profile directory" )] [switch] $UseHomeREADME, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = "Use README in OneDrive directory" )] [switch] $UseOneDriveREADME ####################################################################### ) begin { Write-Verbose "Starting Add-IssueLineToREADME" } process { if (![string]::IsNullOrWhiteSpace($Line)) { # prefix line with current date $Line = "$([DateTime]::Now.ToString('yyyyMMdd')) --> $Line" Write-Verbose "Formatted issue line: $Line" } # add line to readme using base function Add-LineToREADME ` -Code:$Code ` -Show:$Show ` -Section "## Issues" ` -Prefix "- [ ] " ` -Line $Line ` -UseHomeREADME:$UseHomeREADME ` -UseOneDriveREADME:$UseOneDriveREADME } end { } } |