Functions/GenXdev.Coding/Add-IdeaLineToREADME.ps1
|
<############################################################################## Part of PowerShell module : GenXdev.Coding Original cmdlet filename : Add-IdeaLineToREADME.ps1 Original author : René Vaessen / GenXdev Version : 3.28.2026 ################################################################################ Copyright (c) 2026 René Vaessen / GenXdev Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ################################################################################> ############################################################################### <# .SYNOPSIS Adds an idea item to the README.md file. .DESCRIPTION Adds a timestamped idea to the "## Ideas" section of a README.md file. Can display the modified section and open in Visual Studio Code. .PARAMETER Line The idea 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. .PARAMETER Priority Line priority for sorting within the section. Higher values appear first. .PARAMETER SortByDate Sort lines by date (yyyyMMdd prefix) instead of priority. .PARAMETER Ascending Reverse the sort order. By default, higher priority/newer dates appear first. .PARAMETER First Limit the -Show output to the first N lines. Does not affect file storage. .EXAMPLE Add-IdeaLineToREADME -Line "Create new PowerShell module" -Show .EXAMPLE idea "New feature idea" -UseOneDriveREADME #> function Add-IdeaLineToREADME { [CmdletBinding()] [Alias('idea')] param( ####################################################################### [Parameter( Position = 0, Mandatory = $false, ValueFromRemainingArguments = $false, HelpMessage = 'The idea text to add' )] [AllowEmptyString()] [string] $Line = '', ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Mark idea as completed' )] [switch] $Done, ####################################################################### [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, ####################################################################### [Parameter( Position = 1, Mandatory = $false, HelpMessage = 'Priority for sorting (higher = shown first, default 1)' )] [int] $Priority = 1, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Sort lines by date (yyyyMMdd prefix) instead of priority' )] [switch] $SortByDate, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Reverse the sort order (ascending instead of descending)' )] [switch] $Ascending, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Limit -Show output to the first N lines' )] [int] $First = 0, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Show only completed (☒) items when used with -Show' )] [switch] $OnlyCompleted, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Exclude completed (☒) items when used with -Show' )] [switch] $ExcludeCompleted, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Archive completed items from this section' )] [switch] $ArchiveCompleted, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = 'File path for archiving completed items externally' )] [string] $ArchiveFilePath ####################################################################### ) begin { Microsoft.PowerShell.Utility\Write-Verbose 'Starting Add-IdeaLineToREADME' } process { if (![string]::IsNullOrWhiteSpace($Line) -and !$Done) { # prefix line with current date $Line = "$([DateTime]::Now.ToString('yyyyMMdd')) --> $Line" Microsoft.PowerShell.Utility\Write-Verbose "Formatted idea line: $Line" } # add line to readme using base function GenXdev\Add-LineToREADME ` -Code:$Code ` -Show:$Show ` -Section '## Ideas' ` -Line $Line ` -Done:$Done ` -UseHomeREADME:$UseHomeREADME ` -UseOneDriveREADME:$UseOneDriveREADME ` -Priority $Priority ` -SortByDate:$SortByDate ` -Ascending:$Ascending ` -OnlyCompleted:$OnlyCompleted ` -ExcludeCompleted:$ExcludeCompleted ` -ArchiveCompleted:$ArchiveCompleted ` -ArchiveFilePath $ArchiveFilePath ` -First $First } end { } } |