Functions/GenXdev.Coding/Add-FeatureLineToREADME.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Coding Original cmdlet filename : Add-FeatureLineToREADME.ps1 Original author : René Vaessen / GenXdev Version : 1.270.2025 ################################################################################ MIT License Copyright 2021-2025 GenXdev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ################################################################################> ############################################################################### <# .SYNOPSIS Adds a feature line to the README file with a timestamp. .DESCRIPTION Adds a feature line to the specified README file, prefixed with the current date in yyyyMMdd format. The line can be formatted as code and optionally displayed. .PARAMETER Line The feature description text to add to the README file. .PARAMETER Code Switch to format the line as code in the README file. .PARAMETER Show Switch to display the README file after adding the line. .PARAMETER UseHomeREADME Switch to use the README file in the home directory. .PARAMETER UseOneDriveREADME Switch to use the README file in the OneDrive directory. .EXAMPLE Add-FeatureLineToREADME -Line "Added new Git feature" .EXAMPLE feature "Added new Git feature" -Code -Show #> function Add-FeatureLineToREADME { [CmdletBinding()] [Alias('feature')] param( ####################################################################### [Parameter( Position = 0, ValueFromRemainingArguments = $false, Mandatory = $false, HelpMessage = 'The feature description text to add' )] [string] $Line = '', ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Format the line as code' )] [switch] $Code, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Display the README after adding the line' )] [switch] $Show, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Use README in home directory' )] [switch] $UseHomeREADME, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Use README in OneDrive directory' )] [switch] $UseOneDriveREADME ) begin { Microsoft.PowerShell.Utility\Write-Verbose "Starting Add-FeatureLineToREADME with line: $Line" } process { # format the line with timestamp if not empty if ([string]::IsNullOrWhiteSpace($Line) -eq $false) { $Line = "$([DateTime]::Now.ToString('yyyyMMdd')) --> $Line" Microsoft.PowerShell.Utility\Write-Verbose "Formatted line: $Line" } # add the line to the README file GenXdev.Coding\Add-LineToREADME ` -Code:$Code ` -Show:$Show ` -Section '## Features' ` -Prefix '- [X] ' ` -Line $Line ` -UseHomeREADME:$UseHomeREADME ` -UseOneDriveREADME:$UseOneDriveREADME } end { } } |