refactoring to the Generate-ProductivityReport.ps1 script
#3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
feat: Collapsible Workspace Guidance + docs sync + validator JSON guidance generation
Enhance license header script and update README
Resolved merge conflicts and integrated changes in Generate-ProductivityReport.ps1, improving interactive prompts, report generation, and output formatting. Added a new, more detailed New-RowObject implementation to Recursive-Directory-Analysis.ps1, supporting enhanced CSV export with Excel hyperlink formulas and reordered columns for better usability.
Resolved merge conflicts and integrated changes in Generate-ProductivityReport.ps1, improving interactive prompts, report generation, and output formatting. Added a new, more detailed New-RowObject implementation to Recursive-Directory-Analysis.ps1, supporting enhanced CSV export with Excel hyperlink formulas and reordered columns for better usability.
KCoderVA
added a commit
that referenced
this pull request
Aug 29, 2025
Merge pull request #3 from KCoderVA/main
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces significant improvements and refactoring to the Generate-ProductivityReport.ps1 script, focusing on enhancing the HTML report output, improving user interaction, and updating the summary and configuration display. The changes include a redesigned report layout with a new activity trend chart, more flexible user prompts, and improved KPI presentation.
- Redesigned HTML report output with new CSS layout, responsive components, and a canvas-based activity trend chart with dynamic period grouping
- Enhanced user interaction prompts to accept both numeric and named choices for better usability
- Improved configuration summary display and updated intro text for better clarity
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| copilot-instructions/tasks.json | Removed trailing space from command line arguments |
| copilot-instructions/Validate-WorkspaceSetup.ps1 | Updated condition to trigger guidance generator for both errors and warnings |
| copilot-instructions/Recursive-Directory-Analysis.ps1 | Added commented-out duplicate function definition |
| copilot-instructions/Generate-ProductivityReport.ps1 | Major refactoring with new HTML layout, enhanced user prompts, improved chart functionality, and git merge conflict markers |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Comment on lines
+463
to
+528
| <# | ||
| --------------------------------------------------------------------- | ||
| function New-RowObject { | ||
| param( | ||
| [string]$ItemType, | ||
| [System.IO.FileSystemInfo]$Item, | ||
| [Nullable[int64]]$SizeBytes, | ||
| [string]$Author, | ||
| [Nullable[int]]$Lines, | ||
| [Nullable[int64]]$Chars) | ||
| $ext = if (-not $Item.PSIsContainer) { ($Item.Extension.ToLowerInvariant()); } else { $null } | ||
| $attrs = Get-ItemAttributesBooleans -Item $Item | ||
| $created = try { $Item.CreationTime.ToString("yyyy-MM-ddTHH:mm:ss.fffK") } catch { '' } | ||
| $modified = try { $Item.LastWriteTime.ToString("yyyy-MM-ddTHH:mm:ss.fffK") } catch { '' } | ||
| $name = try { $Item.Name } catch { [System.IO.Path]::GetFileName($Item.FullName) } | ||
| $full = try { $Item.FullName } catch { $null } | ||
| $extVal = if ($ext) { $ext } else { '' } | ||
| $sizeVal = if ($null -ne $SizeBytes) { [string]$SizeBytes } else { '' } | ||
| $linesVal = if ($null -ne $Lines) { [string]$Lines } else { '' } | ||
| $charsVal = if ($null -ne $Chars) { [string]$Chars } else { '' } | ||
| # Build Excel HYPERLINK formula for the FullPath column | ||
| # Requirement: clicking opens the containing folder/location, not the item itself. | ||
| $fullForLink = if ($full) { $full } else { '' } | ||
| $containingFolder = try { | ||
| if ($Item.PSIsContainer) { | ||
| if ($Item.Parent) { $Item.Parent.FullName } else { $Item.FullName } | ||
| } else { | ||
| $Item.DirectoryName | ||
| } | ||
| } catch { $fullForLink } | ||
| if ([string]::IsNullOrWhiteSpace($containingFolder)) { $containingFolder = $fullForLink } | ||
| # Escape double quotes for CSV/formula safety (Excel uses doubled quotes inside formulas) | ||
| $dispText = $fullForLink -replace '"','""' | ||
| $targetPath = $containingFolder -replace '"','""' | ||
| $fullHyperlink = if ([string]::IsNullOrEmpty($fullForLink)) { '' } else { [string]::Format('=HYPERLINK("{0}","{1}")', $targetPath, $dispText) } | ||
| # Reordered columns: | ||
| # Far left: CreatedTime, LastModifiedTime, Author, IsReparsePoint, IsHidden, IsReadOnly, IsSystem, IsArchive | ||
| # Then FullPath (as hyperlink), Name, and remaining columns | ||
| $obj = [ordered]@{ | ||
| CreatedTime = $created | ||
| LastModifiedTime = $modified | ||
| Author = $Author | ||
| IsReparsePoint = [string](Test-ReparsePoint -Item $Item) | ||
| IsHidden = [string]$($attrs.IsHidden) | ||
| IsReadOnly = [string]$($attrs.IsReadOnly) | ||
| IsSystem = [string]$($attrs.IsSystem) | ||
| IsArchive = [string]$($attrs.IsArchive) | ||
| FullPath = $fullHyperlink | ||
| Name = $name | ||
| ItemType = $ItemType | ||
| Extension = $extVal | ||
| SizeBytes = $sizeVal | ||
| LinesOfText = $linesVal | ||
| CharacterCount = $charsVal | ||
| } | ||
| return [PSCustomObject]$obj | ||
| } | ||
| ---------------------------------------------------------------------- | ||
| #> |
There was a problem hiding this comment.
There is a large block of commented-out code that appears to be a duplicate of the existing New-RowObject function. This duplicated code should be removed to improve maintainability and avoid confusion.
Copilot uses AI. Check for mistakes.
Comment on lines
+214
to
+225
| <<<<<<< Updated upstream | ||
| <<<<<<< Updated upstream | ||
| # Conditional console writer (suppressed when -Quiet) | ||
| function Write-Info { | ||
| param([string]$Text, [ConsoleColor]$Color = [ConsoleColor]::Gray) | ||
| if (-not $Quiet) { Write-Host $Text -ForegroundColor $Color } | ||
| } | ||
|
|
||
| ======= | ||
| >>>>>>> Stashed changes | ||
| ======= | ||
| >>>>>>> Stashed changes |
There was a problem hiding this comment.
Git merge conflict markers are present in the code. These need to be resolved before merging.
Suggested change
| <<<<<<< Updated upstream | |
| <<<<<<< Updated upstream | |
| # Conditional console writer (suppressed when -Quiet) | |
| function Write-Info { | |
| param([string]$Text, [ConsoleColor]$Color = [ConsoleColor]::Gray) | |
| if (-not $Quiet) { Write-Host $Text -ForegroundColor $Color } | |
| } | |
| ======= | |
| >>>>>>> Stashed changes | |
| ======= | |
| >>>>>>> Stashed changes | |
| # Conditional console writer (suppressed when -Quiet) | |
| function Write-Info { | |
| param([string]$Text, [ConsoleColor]$Color = [ConsoleColor]::Gray) | |
| if (-not $Quiet) { Write-Host $Text -ForegroundColor $Color } | |
| } |
Copilot uses AI. Check for mistakes.
Comment on lines
+261
to
265
| <<<<<<< Updated upstream | ||
| <<<<<<< Updated upstream | ||
| Write-Host "" | ||
| Write-Host "What this tool does:" -ForegroundColor Cyan | ||
| Write-Host " Creates a decision-ready snapshot of development activity in this workspace for a selected period." -ForegroundColor Gray |
There was a problem hiding this comment.
Git merge conflict markers are present in the code. These need to be resolved before merging.
Copilot uses AI. Check for mistakes.
Comment on lines
+305
to
+318
| ======= | ||
| ======= | ||
| >>>>>>> Stashed changes | ||
| Write-Host ""; Write-Host "About this tool" -ForegroundColor Cyan | ||
| Write-Host "Purpose: Generate a concise productivity snapshot for a chosen time period." -ForegroundColor Gray | ||
| Write-Host "Scope: Analyzes Git activity in this workspace and parses productivity logs (if present)." -ForegroundColor Gray | ||
| Write-Host "Intended use: Management/status reporting and personal tracking—not precise timekeeping." -ForegroundColor Gray | ||
| Write-Host "Expected results: A report file (Markdown/HTML/JSON/CSV) with commit counts, code deltas, and an effort estimate." -ForegroundColor Gray | ||
| Write-Host "Notes: The report is a snapshot of the selected period (Daily/Weekly/Monthly/All time/Custom)." -ForegroundColor Gray | ||
| Write-Host " Use Custom for exact start/end dates. Opening the report is optional and can be automated." -ForegroundColor Gray | ||
| <<<<<<< Updated upstream | ||
| >>>>>>> Stashed changes | ||
| ======= | ||
| >>>>>>> Stashed changes |
There was a problem hiding this comment.
Git merge conflict markers are present in the code. These need to be resolved before merging.
Copilot uses AI. Check for mistakes.
Comment on lines
+2561
to
+2572
| Write-Progress -Id $progressId -Activity "Productivity Report" -Status "Analyzing workspace activity..." -PercentComplete 35 | ||
|
|
||
| # Select output format (interactive if not provided) | ||
| if (-not $PSBoundParameters.ContainsKey('OutputFormat')) { | ||
| $OutputFormat = Get-OutputFormatInteractive | ||
| } | ||
| Write-Host "Output Format: $OutputFormat" -ForegroundColor Yellow | ||
|
|
||
| Show-ConfigSummary -ReportType $ReportType -StartDate $StartDate -EndDate $EndDate -OutputFormat $OutputFormat -OpenAfterGeneration:$OpenAfterGeneration -IncludeDetailed:$IncludeDetailed | ||
|
|
||
| Write-Progress -Id $progressId -Activity "Productivity Report" -Status "Analyzing workspace activity..." -PercentComplete 35 | ||
|
|
There was a problem hiding this comment.
There is duplicated code block that selects output format, shows configuration summary, and writes progress. This duplication should be removed to avoid redundant execution.
Suggested change
| Write-Progress -Id $progressId -Activity "Productivity Report" -Status "Analyzing workspace activity..." -PercentComplete 35 | |
| # Select output format (interactive if not provided) | |
| if (-not $PSBoundParameters.ContainsKey('OutputFormat')) { | |
| $OutputFormat = Get-OutputFormatInteractive | |
| } | |
| Write-Host "Output Format: $OutputFormat" -ForegroundColor Yellow | |
| Show-ConfigSummary -ReportType $ReportType -StartDate $StartDate -EndDate $EndDate -OutputFormat $OutputFormat -OpenAfterGeneration:$OpenAfterGeneration -IncludeDetailed:$IncludeDetailed | |
| Write-Progress -Id $progressId -Activity "Productivity Report" -Status "Analyzing workspace activity..." -PercentComplete 35 |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant improvements and refactoring to the
Generate-ProductivityReport.ps1script, focusing on enhancing the HTML report output, improving user interaction, and updating the summary and configuration display. The changes include a redesigned report layout with a new activity trend chart, more flexible user prompts, and improved KPI presentation. Some code was also cleaned up and reorganized for clarity.Report Output & Layout Enhancements
.container,.chart-card, and improved KPI cards. Added a canvas-based activity trend chart (commits per period) with dynamic resizing and period grouping (daily/weekly/monthly) for visualizing commit activity. (copilot-instructions/Generate-ProductivityReport.ps1, [1] [2] [3] [4] [5]copilot-instructions/Generate-ProductivityReport.ps1, copilot-instructions/Generate-ProductivityReport.ps1R1471-R1552)User Interaction Improvements
copilot-instructions/Generate-ProductivityReport.ps1, [1] [2]copilot-instructions/Generate-ProductivityReport.ps1, [1] [2]Configuration & Summary Display
copilot-instructions/Generate-ProductivityReport.ps1, [1] [2]Code Cleanup
copilot-instructions/Generate-ProductivityReport.ps1, copilot-instructions/Generate-ProductivityReport.ps1L1)Overall, these changes make the productivity report more informative, visually engaging, and user-friendly.