v0.16.0

Author: jdhitsolutions

PSProjectStatus-Help.pdf

@@ -2,7 +2,7 @@
 
 @{
     RootModule           = 'PSProjectStatus.psm1'
-    ModuleVersion        = '0.15.0'
+    ModuleVersion        = '0.16.0'
     CompatiblePSEditions = 'Desktop', 'Core'
     GUID                 = 'ec249544-dc4e-4e24-aae8-4281ec84f54d'
     Author               = 'Jeff Hicks'
@@ -27,56 +27,22 @@
             ProjectUri               = 'https://github.com/jdhitsolutions/PSProjectStatus'
             IconUri                  = 'https://raw.githubusercontent.com./jdhitsolutions/PSProjectStatus/main/images/psproject-icon.png'
             ReleaseNotes             = @'
-## [0.15.0] - 2025-01-06
+## [0.16.0] - 2025-01-07
 
 ### Added
 
-- Added command `Open-PSProjectStatusHelp` to open a PDF version of the `README` file.
-- Updated help documentation.
+- Added localized verbose messaging, help documentation, and a version of the README help to French. Translations were done with GitHub CoPilot so I can't guarantee the quality.
 
 ### Changed
 
-- Updated verbose messaging.
 - Updated `README.md`.
-
-### Fixed
-
-- Fixed bug in JSON schema for required `RemoteRegistry` properties.
-- Fixed layout errors in the changelog.
-
-## [0.15.0] - 2025-01-06
-
-### Added
-
-- Added command `Open-PSProjectStatusHelp` to open a PDF version of the `README` file.
-- Updated help documentation.
-
-### Changed
-
-- Updated verbose messaging.@'
-## [0.15.0] - 2025-01-06
-
-### Added
-
-- Added command `Open-PSProjectStatusHelp` to open a PDF version of the `README` file.
 - Updated help documentation.
-
-### Changed
-
-- Updated verbose messaging.
-- Updated `README.md`.
-
-### Fixed
-
-- Fixed bug in JSON schema for required `RemoteRegistry` properties.
-- Fixed layout errors in the changelog.
-
-- Updated `README.md`.
+- Revised PDF layout settings.
 
 ### Fixed
 
-- Fixed bug in JSON schema for required `RemoteRegistry` properties.
-- Fixed layout errors in the changelog.
+- Fixed `Get-PSProjectTask` bug. [Issue #14](https://github.com/jdhitsolutions/PSProjectStatus/issues/14).
+- Fixed `Open-PSProjectStatusHelp` to make `-AsMarkdown` a dynamic parameter for PowerShell 7. [Issue #13](https://github.com/jdhitsolutions/PSProjectStatus/issues/13)
 '@
             RequireLicenseAcceptance = $false
         }

PSProjectStatus.psd1

@@ -1,14 +1,14 @@
 #region load string data
 # used for culture debugging
-# write-host "Importing with culture $(Get-Culture)" -ForeGroundColor yellow
+#Write-Host "Importing with culture $(Get-Culture)" -ForeGroundColor yellow
 
 if ((Get-Culture).Name -match '\w+') {
-    #write-host "Using culture $(Get-Culture)" -ForegroundColor yellow
+    #Write-Host "Using culture $(Get-Culture)" -ForegroundColor yellow
     Import-LocalizedData -BindingVariable strings
 }
 else {
     #force using En-US if no culture found, which might happen on non-Windows systems.
-    #write-host "Loading $PSScriptRoot/en-us/PSWorkItem.psd1" -ForegroundColor yellow
+    #Write-Host "Loading $PSScriptRoot/en-us/PSWorkItem.psd1" -ForegroundColor yellow
     Import-LocalizedData -BindingVariable strings -FileName psprojectstatus.psd1 -BaseDirectory $PSScriptRoot/en-us
 }
 
@@ -66,6 +66,11 @@ Class PSProjectRemote {
 }
 
 Class PSProjectTask {
+    <#
+    this class is designed with future enhancements in mind.
+    Not all properties are utilized in the current version of the module.
+    #>
+
     [int32]$TaskID
     [string]$TaskName
     [string]$TaskDescription
@@ -78,6 +83,8 @@ Class PSProjectTask {
     [Int32]$Progress = 0
     [string]$AssignedTo = [System.Environment]::Username
     [System.Boolean]$Completed = $false
+    [string]$ProjectName
+    [string]$Path
 
     PSProjectTask ([string]$TaskName) {
         # $this.TaskID = _getNextTaskID
@@ -326,7 +333,7 @@ $jsonSchema = 'https://raw.githubusercontent.com/jdhitsolutions/PSProjectStatus/
 #a hash table to store ANSI escape sequences for different commands used in verbose output with the
 #private _verbose helper function
 $PSProjectANSI = @{
-    'Get-PSProjectGitStatus' = '[1;38;5;51m'
+    'Get-PSProjectGitStatus' = '[1;38;5;140m'
     'Get-PSProjectReport'    = '[1;38;5;111m'
     'Get-PSProjectStatus'    = '[1;96m'
     'Get-PSProjectTask'      = '[1;38;5;10m'
@@ -336,10 +343,11 @@ $PSProjectANSI = @{
     'Set-PSProjectStatus'    = '[1;38;5;214m'
     Default                  = '[1;38;5;51m'
 }
+
 Set-Variable -Name PSProjectANSI -Description "a hash table to store ANSI escape sequences for different commands used in verbose output. You can modify settings using ANSI sequences or `$PSStyle"
 
 #Export the module version to a global variable that will be used in Verbose messages
-New-Variable -Name PSProjectStatusModule -Value '0.14.0' -Description 'The PSProjectStatus module version used in verbose messaging.'
+New-Variable -Name PSProjectStatusModule -Value '0.16.0' -Description 'The PSProjectStatus module version used in verbose messaging.'
 
 Export-ModuleMember -Variable PSProjectStatusModule, PSProjectANSI -Alias 'Update-PSProjectStatus', 'gitstat', 'gpstat', 'npstat', 'spstat'
 

PSProjectStatus.psm1

@@ -40,7 +40,7 @@ This module is supported in Windows PowerShell 5.1 and PowerShell 7.
 - [Get-PSProjectGitStatus](docs/Get-PSProjectGitStatus.md)
 - [Open-PSProjectStatusHelp](docs/Open-PSProjectStatusHelp.md)
 
-After importing the module you can run `Open-PSProjectStatusHelp` which will open a PDF version of this document in the default application associated with PDF files. Or you can use the -`AsMarkdown` parameter to read this file using markdown formatting. Not all markdown features may properly render in the console.
+After importing the module you can run `Open-PSProjectStatusHelp` which will open a PDF version of this document in the default application associated with PDF files. Or if you are running PowerShell 7, you can use the `-AsMarkdown` dynamic parameter to read this file using markdown formatting. Not all markdown features may render properly in the console.
 
 ## Class-Based
 
@@ -64,15 +64,16 @@ Class PSProjectRemote {
   }
 }
 
-#I have formatted longer lines with artificial line breaks to fit a printed page.
+#I have formatted longer lines with artificial line breaks to fit a
+#printed page.
 Class PSProject {
   [string]$Name = (Split-Path (Get-Location).path -Leaf)
   [string]$Path = (Convert-Path (Get-Location).path)
   [DateTime]$LastUpdate = (Get-Date)
   [string[]]$Tasks = @()
   [PSProjectStatus]$Status = 'Development'
-  [Version]$ProjectVersion = (Test-ModuleManifest ".\$(Split-Path $pwd -Leaf).psd1" `
-  -ErrorAction SilentlyContinue).version
+  [Version]$ProjectVersion = (Test-ModuleManifest ".\$(Split-Path $pwd `
+  -Leaf).psd1" -ErrorAction SilentlyContinue).version
   [string]$GitBranch = ''
   #using .NET classes to ensure compatibility with non-Windows platforms
   [string]$UpdateUser = "$([System.Environment]::UserDomainName)\`
@@ -86,18 +87,19 @@ Class PSProject {
       #convert the ProjectVersion to a string in the JSON file
       #convert the LastUpdate to a formatted date string
       $this | Select-Object @{Name = '$schema'; Expression = {
-      'https://raw.githubusercontent.com/jdhitsolutions/PSProjectStatus/main/
-      psproject.schema.json' } },
+      'https://raw.githubusercontent.com/jdhitsolutions/PSProjectStatus/
+      main/psproject.schema.json' } },
       Name, Path,
-      @{Name = 'LastUpdate'; Expression = { '{0:o}' -f $_.LastUpdate } },
-      @{Name = 'Status'; Expression = { $_.status.toString() } },
-      @{Name = 'ProjectVersion'; Expression = { $_.ProjectVersion.toString() } },
-      UpdateUser, Computername, RemoteRepository, Tasks, GitBranch, Comment |
+      @{Name = 'LastUpdate'; Expression = { '{0:o}' -f $_.LastUpdate }},
+      @{Name = 'Status'; Expression = { $_.status.toString() }},
+      @{Name = 'ProjectVersion'; Expression = {
+        $_.ProjectVersion.toString()}},UpdateUser,Computername,
+        RemoteRepository,Tasks,GitBranch,Comment |
       ConvertTo-Json | Out-File -FilePath $json -Encoding utf8
   }
   [void]RefreshProjectVersion() {
-      $this.ProjectVersion = (Test-ModuleManifest ".\$(Split-Path $pwd -Leaf).psd1" `
-      -ErrorAction SilentlyContinue).version
+      $this.ProjectVersion = (Test-ModuleManifest ".\$(Split-Path $pwd `
+       -Leaf).psd1" -ErrorAction SilentlyContinue).version
   }
   [void]RefreshUser() {
       $this.UpdateUser = "$([System.Environment]::UserDomainName)\`
@@ -116,7 +118,8 @@ Class PSProject {
                   $RemoteName = $split[0]
                   $Url = $split[1]
                   $Mode = $split[2].replace('(', '').Replace(')', '')
-                  $repos += [PSProjectRemote]::new($RemoteName, $url, $mode)
+                  $repos += [PSProjectRemote]::new($RemoteName, $url,
+                  $mode)
               } #foreach
               $this.RemoteRepository = $repos
           } #if remotes found
@@ -197,8 +200,8 @@ To create a project status file, navigate to the module root and run [New-PSProj
 You can update properties when you create the project status.
 
 ```powershell
-New-PSProjectStatus -LastUpdate (Get-Item .\*.psd1).LastWriteTime -Status Updating `
--tasks "update help"
+New-PSProjectStatus -LastUpdate (Get-Item .\*.psd1).LastWriteTime `
+-Status Updating -tasks "update help"
 ```
 
 ![new custom project status](images/new-psprojectstatus2.png)
@@ -207,8 +210,8 @@ The command will create `psproject.json` in the root folder.
 
 ```json
 {
-  "$schema": "https://raw.githubusercontent.com/jdhitsolutions/PSProjectStatus/
-  main/psproject.schema.json",
+  "$schema": "https://raw.githubusercontent.com/jdhitsolutions/
+  PSProjectStatus/main/psproject.schema.json",
   "Name": "PSHelpDesk",
   "Path": "C:\\Scripts\\PSHelpDesk",
   "LastUpdate": "2024-02-20T09:47:33-05:00",
@@ -255,7 +258,7 @@ PS C:\scripts\PSCalendar> Get-PSProjectStatus | Format-List
 
 Version    : 2.9.0
 Status     : Patching
-Tasks      : {Update help documentation, Issue #31, Issue #34, Issue #33}
+Tasks      : {Update help documentation, Issue #31,Issue #34,Issue #33}
 GitBranch  : 2.9.0
 LastUpdate : 3/3/2024 10:24:49 AM
 ```
@@ -355,15 +358,18 @@ $p.RefreshRemoteRepository()
 $p.save()
 ```
 
-![refresh a project status]As an alternative can use the `RefreshAll()` method which will invoke all the refresh methods __and__ save the file.
+As an alternative can use the `RefreshAll()` method which will invoke all the refresh methods __and__ save the file.
 
 ## Project Tasks
 
 This module is intended to be a _simple_ project management tool. You can use it to track tasks or to-do items. These are added to the `Tasks` property as an array of strings. You can manually add them to the JSON file or use the `Set-PSProjectStatus` function.
 
 ```powershell
-C:\Scripts\PSProjectStatus> $params = @{Tasks="Update missing online help links";
-Concatenate=$true}
+C:\Scripts\PSProjectStatus> $params = @{
+ Tasks="Update missing online help links"
+ Concatenate=$true
+ }
+
 C:\Scripts\PSProjectStatus> Set-PSProjectStatus @params
 
    Name: PSProjectStatus [C:\Scripts\PSProjectStatus]
@@ -389,6 +395,8 @@ You can manually remove items from the JSON file or use the `Remove-PSProjectTas
 Remove-PSProjectTask -TaskID 4
 ```
 
+Note: *The `PSProjectTask` object is defined in a PowerShell class. The class is defined with future enhancements in mind. Not all defined properties are used at this time.*
+
 ## Project Management
 
 If you have many projects, you can use this module to manage all of them.
@@ -542,14 +550,14 @@ LastUpdate       Property       datetime LastUpdate {get;set;}
 Name             Property       string Name {get;set;}
 Path             Property       string Path {get;set;}
 ProjectVersion   Property       version ProjectVersion {get;set;}
-RemoteRepository Property       PSProjectRemote[] RemoteRepository {get;set;}
+RemoteRepository Property       PSProjectRemote[] RemoteRepository  ...
 Status           Property       PSProjectStatus Status {get;set;}
 Tags             Property       string[] Tags {get;set;}
 Tasks            Property       string[] Tasks {get;set;}
 UpdateUser       Property       string UpdateUser {get;set;}
-Info             PropertySet    Info {Name, Status, Version, GitBranch, Tasks...
-versionInfo      PropertySet    versionInfo {Name, Status, Version, GitBranch...
-Age              ScriptProperty System.Object Age {get=(Get-Date) - $this.las...
+Info             PropertySet    Info {Name, Status, Version, GitBranc...
+versionInfo      PropertySet    versionInfo {Name, Status, Version, G...
+Age              ScriptProperty System.Object Age {get=(Get-Date) -  ...
 ```
 
 The property sets make it easier to display a group of related properties.
@@ -561,13 +569,14 @@ Name      : PSProjectStatus
 Status    : AcceptanceTesting
 Version   : 0.13.0
 GitBranch : 0.13.0
-Tasks     : {Create TUI-based management tools, Consider extending schema for a
-             structured Task item [Issue 10],
+Tasks     : {Create TUI-based management tools, Consider extending schema
+            for a structured Task item [Issue 10],
             Pester tests}
 Tags      : {}
 Comment   : none
 
-PS C:\Scripts\PSProjectStatus> Get-PSProjectStatus | Select-Object VersionInfo,Age
+PS C:\Scripts\PSProjectStatus> Get-PSProjectStatus |
+Select-Object VersionInfo,Age
 
 Name       : PSProjectStatus
 Status     : AcceptanceTesting
@@ -600,14 +609,15 @@ Age        : 173.20:28:04
 There is also a named view you can use.
 
 ```powershell
-PS C:\Scripts\PSProjectStatus> Get-PSProjectStatus | Format-List -View info
+PS C:\Scripts\PSProjectStatus> Get-PSProjectStatus |
+Format-List -View info
 
    Project: PSProjectStatus [C:\Scripts\PSProjectStatus]
 
 Status  : Updating
-Tasks   : {Create TUI-based management tools, Consider extending schema for a
-          structured Task item [Issue 10], Pester tests, Consider adding a
-          project type, eg module, to the schema…}
+Tasks   : {Create TUI-based management tools, Consider extending schema
+          for a structured Task item [Issue 10], Pester tests, Consider
+          adding a project type, eg module, to the schema…}
 Tags    : {json, class-based}
 Comment :
 Age     : 173.20:28:37
@@ -619,6 +629,8 @@ The commands in this module use localized string data to display verbose, warnin
 
 ![Sample verbose output](images/verbose-output.png)
 
+__Note__ *Localized string data to languages other than English was done with GitHub CoPilot, so I can't guarantee the accuracy or quality of the translations. As of version `0.16.0` the supported cultures are `fr-FR`*
+
 The defined ANSI sequences are stored in a hashtable variable called `$PSProjectANSI`.
 
 ```powershell
@@ -702,6 +714,6 @@ These are a few things I'm considering or have been suggested.
 + Archiving completed tasks to a separate JSON file
 + A WPF or TUI form to display the project status and make it easier to edit tasks
 
-🗨️ If you have any suggestions on how to extend this module or tips to others on how you are using it, please feel free to use the [Discussions](https://github.com/jdhitsolutions/PSProjectStatus/discussions) section of this module's GitHub repository.
+:left_speech_bubble: If you have any suggestions on how to extend this module or tips to others on how you are using it, please feel free to use the [Discussions](https://github.com/jdhitsolutions/PSProjectStatus/discussions) section of this module's GitHub repository.
 
 > :thumbsup: Project icon by [Icons8](https://icons8.com)

README.md

@@ -2,6 +2,23 @@
 
 ## [Unreleased]
 
+## [0.16.0] - 2025-01-07
+
+### Added
+
+- Added localized verbose messaging, help documentation, and a version of the README help to French. Translations were done with GitHub CoPilot so I can't guarantee the quality.
+
+### Changed
+
+- Updated `README.md`.
+- Updated help documentation.
+- Revised PDF layout settings.
+
+### Fixed
+
+- Fixed `Get-PSProjectTask` bug. [Issue #14](https://github.com/jdhitsolutions/PSProjectStatus/issues/14).
+- Fixed `Open-PSProjectStatusHelp` to make `-AsMarkdown` a dynamic parameter for PowerShell 7. [Issue #13](https://github.com/jdhitsolutions/PSProjectStatus/issues/13)
+
 ## [0.15.0] - 2025-01-06
 
 ### Added
@@ -238,7 +255,8 @@
 - Modified `New-PSProjectStatus` to convert all paths to full filesystem paths and not PSDrives.
 - Updated `psproject.format.ps1xml` to adjust table widths. Added a default list view.
 
-[Unreleased]: https://github.com/jdhitsolutions/PSProjectStatus/compare/v0.15.0..HEAD
+[Unreleased]: https://github.com/jdhitsolutions/PSProjectStatus/compare/v0.16.0..HEAD
+[0.16.0]: https://github.com/jdhitsolutions/PSProjectStatus/compare/v0.15.0..v0.16.0
 [0.15.0]: https://github.com/jdhitsolutions/PSProjectStatus/compare/vv0.14.1..v0.15.0
 [v0.14.1]: https://github.com/jdhitsolutions/PSProjectStatus/compare/v0.14.0..v0.14.1
 [v0.14.0]: https://github.com/jdhitsolutions/PSProjectStatus/compare/v0.13.1..v0.14.0