changelog.md

Changelog for PSWorkItem

Unreleased

1.10.0 - 2024-05-28

Added

• Added argument completer for the ID parameter of Complete-PSWorkItem, Set-PSWorkItem, and Remove-PSWorkItem

Changed

• Updated README
• Updated Terminal.gui assembly to version 1.16.0
• Updated Nstack assembly to version 1.1.1.0

1.9.0 - 2024-02-24

Changed

• Update TUI to allow filtering table by the number of days dues.
• Updated TUI to show about information using a dialog instead of a message box to allow for better formatting.
• Update TUI-based console so that selected category is always in view.

Fixed

• Fixed hard-coded references in private functions that were pointing to C:\temp.

1.8.0 - 2024-02-23

Added

• Added mySQLite module version to the About display in Open-POSWorkItemConsole.
• Added an about_psworkitem help topic
• Added support for running on Linux-x64 platforms.

Changed

• Updated Open-PSWorkItemConsole to use the $PSWorkItemDefaultDays value instead of the hard-coded 30.
• Updated help documentation
• Updated README.md.
• Revised module description.

Fixed

• Fixed bug importing localized data on non-Windows systems.

1.7.0 - 2024-01-07

Changed

• Updated the sample PSWorkItem database.
• Revised format file for PSWorkItems to show due date with leading zeros and no seconds.
• Updated Open-PSWorkItemConsole to format due dates with leading zeros and no seconds.
• Updated Open-PSWorkItemConsole to display overdue items in the table in Red and items due within 5 days in Cyan.
• Updated table layout in Open-PSWorkItemConsole. Added a RepresentationGetter to display progress value with a % sign. Hiding the Overdue column to give more space to the Name and Description columns.

Fixed

• Update the TUI form which was hiding the Clear checkbox
• Fixed missing properties in the PSWorkItemDatabase class.

1.5.0 - 2023-10-06

Added

• Added a feature in Open-PSWorkItemConsole to allow the user to right-click on a table row and display PSWorkItem details in a pop-up window.
• Added menu choices in Open-PSWorkItemConsole to manage categories.
• Added additional verbose output.

Changed

• Modified private helper functions to support Verbose output.
• Renamed localized string data file to match module name.

Fixed

• Fixed typo in strings file
• Fixed Open-PSWorkItemConsole to refresh report table when modifying or removing PSWorkItems.
• Fixed bug in Remove-PSWorkItemCategory that wasn't detecting the category value from the dynamic parameter.

1.4.0 - 2023-09-29

Changed

• Help updates.
• Updated README.md.

Fixed

• Fixed bug in Add-PSWorkItemCategory and Initialize-PSWorkItemDatabase that was causing errors using the default categories.

1.3.1 - 2023-09-29

Changed

• Updated README.md.
• Removed minimum version for the MySQLite dependency.

1.3.0 - 2023-09-28

Added

• Added a parameter set to Set-PSWorkItem to let the user clear the description field.
• Added an option for the user to set the default number of days for a new PSWorkItem. The module default is 30 days, but the user can modify the global variable. The preference commands and format file have been updated to reflect this change.
• Added parameter validation for Name and Description parameters to reject values with apostrophes. Apostrophes break SQLite syntax.
• Added command Open-PSWorkItemConsole with an alias of wic. This will create a terminal user interface for managing PSWorkItems.
• Added script property type extension for PSWorkItemCategory called ANSIString to show the ANSI sequence.
• Added command Get-PSWorkItemPreference.
• Added localized string data for verbose, warning, and error messaging.
• Added parameter alias Date to DueDate in New-PSWorkItem.
• Updated module to let the user specify a default category for New-PSWorkItem. This default must be saved with Update-PSWorkItemPreference.

Changed

• Modified Complete-PSWorkItem, Set-PSWorkItem, and Remove-PSWorkItem to accept pipeline input from Get-PSWorkItem.
• Converted the -Category parameter in commands to a dynamic parameter. This allows autocompletion of values if the user specifies an alternate database path. This is a potential breaking change.
• Modified Path parameter in functions to use the newer PowerShell 7 compatible [ValidateScript()] attribute.
• Raised minimum PowerShell version to 7.3. This is a potential breaking change.
• Updated sample PSWorkItem database.
• Modified Get-PSWorkItemData to write System.Data.DataTable output.
• Moved verbose messaging to a private helper function.
• Modified layout of the default view for Get-PSWorkItemReport.
• Updated format file psWorkItemPreference.format.ps1xml.
• Help updates.
• Updated README.md

1.2.0 - 2023-07-26

Added

• Added missing online help links.

Fixed

• Fixed casing in the manifest for format files that was causing an error in non-Windows systems.

1.1.0 - 2023-06-30

Added

• Added a format file for PSWorkItemCategory to display categories using the designated color scheme. Issue #10
• Added command Update-PSWorkItemPreferences to store user preferences in a JSON file stored in $HOME. If the file is found, settings will be imported.
• Added command Set-PSWorkItemCategory Issue 11

Changed

• Updated README.

1.0.1 - 2023-03-13

Changed

• Minor help corrections.
• Added missing online help links.

Fixed

• Fixed warning message in Get-PSWorkItemArchive

1.0.0 - 2023-03-12

This is a major update with significant changes. If this is your first time installing the module, no further action is required. If you are upgrading from a previous version of this module, you will need to run Update-PSWorkItemDatabase. See the README file for more information.

Added

• Added command Update-PSWorkItemDatabase to add the new ID column to the tasks and archive tables.
• Added command Get-PSWorkItemReport.
• Added command Remove-PSWorkItemArchive.
• Added format file psWorkitemreport.format.ps1xml.
• Added property set ProgressSet for the PSWorkItem type.
• Added property type extension Age for PSWorkItem to show the age of the item since it was created.
• Added a table format view called Age for PSWorkItems.

Changed

• Modified module to add an ID property that will be the same in both the Tasks and Archive tables. Commands have been modified to use the RowID for the ID property for the first task. After that, the next ID will be one more than the highest ID found in the tasks or archive table. This is a major breaking change. Issue #7
• Modified the class definitions into distinct items so that the PSWorkItemArchive doesn't inherit properties like Overdue that don't belong. This is a potential breaking change. Issue #8
• updated the sample PSWorkItem database.
• General code cleanup.
• help updates.
• Updated README.md.

Removed

• Removed readme.txt from the Types folder

Fixed

• Fixed bug in Complete-PSWorkItem when using -PassThru

0.9.0 - 2023-01-02

Added

• Added aliases of due and deadline for DueDate for the PSWorkItem type.
• Moved type extensions to external ps1xml files.

Changed

• Updated README.md.
• Migrated CHANGELOG to Keep a Changelog format.

Fixed

• Merged PR #6 to fix Issue #5

0.8.0 - 2022-12-13

Added

• Add database path as a property to workitem and archived workitem objects.

Changed

• Update default format view to group by database path.
• Help updates.

Fixed

• Merged PR#4 that resolves Issue #3 Thank you @jbelina.

0.7.0 - 2022-09-16

Fixed

• Fixed bug in Get-PSWorkItemArchive that was referencing a hardcoded variable and not the parameter.
• Fixed bug in Get-PSWorkItem when filtering by number of days dues.

Updated

• Updated missing online help links.
• Updated commands to better handle dates and respect culture. There is a PowerShell issue where using Get-Date in as a sub-expression fails to respect culture. An expression like "Today is (Get-Date)" may not respect non-US cultures. Using the -f operator does: "Today is "0}" -f (Get-Date). Modified my queries using datetime values accordingly. If you have a database created under a previous version of the module, it is recommended that you use Set-PSWorkItem to touch every item.
• Updated WhatIf message in New-PSWorkItem to include more detail.

0.6.0 - 2022-08-26

Added

• Added Get-PSWorkItemData to get raw table data.

Changed

• Module manifest cleanup.
• Modified New-PSWorkItem and Get-PSWorkItem to better handle dates, especially when running commands under different cultures. These are potential breaking changes.
• Updated README.md.

0.5.0 - 2022-08-03

Changed

• Fixed module manifest. Issue #1
• Updated README.md.

Added

• Added a feature to highlight tasks based on category. The module defines a global variable, $PSWorkItemCategory, which is a hashtable. The key is the category and the value is the $PSStyle or ANSI sequence. The default format view is configured to use these settings.

0.4.0 - 2022-08-02

Added

• Added online help links.
• Defined a module dependency on version 0.9.2 or later of the MySQLite module.
• Created a sample database file.

Changed

• Updated README.
• Help updates.
• Updated module manifest.
• Made Category and Description positional parameters in New-PSWorkItem.
• Published to the PowerShell Gallery.

0.3.0 - 2022-07-30

Added

• Added format file PSWorkItem.format.ps1xml.
• Added Get-PSWorkItem,New-PSWorkItem,Set-PSWorkItem,'Complete-PSWorkItem and Remove-PSWorkItem.
• Added ID parameter to Get-PSWorkItem.
• Added Complete-PSWorkItem.
• Added alias gwi to Get-PSWorkItem.
• Added type PSWorkItemArchive and format view.
• Added an option to set an new tasks due date by the number of days.
• Added a table view called Category for PSWorkItems.
• Added alias nwi to New-PSWorkItem.
• Added type extension TimeRemaining for PSWorkItem and added a supporting table view called countdown.

Changed

• Changed Comment column in Categories table to Description.
• Refined auto-completer for New-PSWorkItem.
• Modified New-PSWorkItem to accept most parameters from the pipeline by property name. This should facilitate importing data from external sources.

Fixed

• Fixed typo in tasks table.
• Made database queries case-insensitive.
• Made $PSWorkItemPath a global variable instead of exporting it. This removes the need to use Export-ModuleMember. The manifest should be sufficient.
• Updated Category argument completer to display "no description" if nothing is defined for the description property.

Removed

• Removed Connection parameter from all commands. The expected database usage is not enough to warrant setting up and managing connections. Some commands will internally use connections where they can be better managed.

0.2.0 - 2022-07-25

Added

• Added Add-PSWorkItemCategory,Get-PSWorkItemCategory, and Remove-PSWorkItemCategory.
• Added Get-PSWorkingItemDatabase.
• Added class definition for PSWorkItemDatabase.
• Added format file PSWorkItemdatabase.format.ps1xml.

Changed

• Updated Initialize-PSWorkItemDatabase to add default categories.
• Improved verbose messaging.

0.1.0 - 2022-07-22

• Initial files
• Created Module outline