✨ [feat] Add code coverage reporting with Codecov

✨ [feat] Adds comprehensive code coverage reporting to the project. This enhances quality assurance by tracking the percentage of code executed during tests.

👷 [ci] Updates the `test.yml` workflow to:
-   Enable Pester's code coverage feature during test runs for both PowerShell 5.1 and pwsh.
-   Generate coverage reports in `JaCoCo` XML format.
-   Upload these reports to Codecov using the `codecov/codecov-action` for analysis and badge generation.

🧪 [test] Introduces a new PowerShell script `scripts/Test-Coverage.ps1` to streamline local testing:
-   Runs Pester tests with coverage analysis.
-   Displays a detailed coverage summary in the console.
-   Enforces a minimum coverage threshold to maintain code quality.
-   Includes an option to generate and open a local HTML coverage report using `ReportGenerator`.

🔧 [build] Adds new npm scripts for convenience:
-   `npm run test:coverage` to execute the coverage script.
-   `npm run test:coverage:report` to generate the HTML report.

📝 [docs] Updates `README.md` to:
-   Add the new Codecov badge.
-   Include a new "Testing" section detailing how to run tests and generate coverage reports.
-   Add a project mascot image.

🧹 [chore] Modifies `.gitignore` to exclude generated test results and coverage report files.

Signed-off-by: Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com>

Author: Nick2bad4u

.github/workflows/test.yml

@@ -37,7 +37,7 @@ jobs:
               Install-Module -Name PSScriptAnalyzer -Force -SkipPublisherCheck
           }
 
-      - name: Run Pester tests
+      - name: Run Pester tests with coverage
         shell: powershell
         run: |
           Import-Module Pester
@@ -46,6 +46,10 @@ jobs:
           $configuration.Output.Verbosity = 'Detailed'
           $configuration.TestResult.Enabled = $true
           $configuration.TestResult.OutputPath = 'test-results.xml'
+          $configuration.CodeCoverage.Enabled = $true
+          $configuration.CodeCoverage.Path = './ColorScripts-Enhanced/*.psm1'
+          $configuration.CodeCoverage.OutputPath = 'coverage.xml'
+          $configuration.CodeCoverage.OutputFormat = 'JaCoCo'
           Invoke-Pester -Configuration $configuration
 
       - name: Upload test results
@@ -55,6 +59,13 @@ jobs:
           name: test-results-windows-51
           path: test-results.xml
 
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@7f8b4b4bde536c465e797be725718b88c5d95e0e # v5.1.2
+        with:
+          files: ./coverage.xml
+          flags: windows-powershell-51
+          name: windows-powershell-51
+
       - name: Validate help topics
         shell: powershell
         run: |
@@ -98,7 +109,7 @@ jobs:
               Install-Module -Name PSScriptAnalyzer -Force -SkipPublisherCheck
           }
 
-      - name: Run Pester tests
+      - name: Run Pester tests with coverage
         shell: pwsh
         run: |
           Import-Module Pester
@@ -107,6 +118,10 @@ jobs:
           $configuration.Output.Verbosity = 'Detailed'
           $configuration.TestResult.Enabled = $true
           $configuration.TestResult.OutputPath = 'test-results.xml'
+          $configuration.CodeCoverage.Enabled = $true
+          $configuration.CodeCoverage.Path = './ColorScripts-Enhanced/*.psm1'
+          $configuration.CodeCoverage.OutputPath = 'coverage.xml'
+          $configuration.CodeCoverage.OutputFormat = 'JaCoCo'
           Invoke-Pester -Configuration $configuration
 
       - name: Upload test results
@@ -116,6 +131,13 @@ jobs:
           name: test-results-${{ matrix.os }}-pwsh
           path: test-results.xml
 
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@7f8b4b4bde536c465e797be725718b88c5d95e0e # v5.1.2
+        with:
+          files: ./coverage.xml
+          flags: pwsh-${{ matrix.os }}
+          name: pwsh-${{ matrix.os }}
+
       - name: Run script analyzer
         shell: pwsh
         run: |

.gitignore

@@ -114,7 +114,8 @@ obj/
 .LSOverride
 
 # Icon must end with two \r
-Icon
+Icon
+
 
 # Thumbnails
 ._*
@@ -341,3 +342,10 @@ ps-color-scripts/*.psd1
 ps-color-scripts/cache/
 .prettier-cache
 node_modules/
+
+# Code coverage reports
+coverage.xml
+coverage-report/
+testResults.xml
+test-results.xml
+*.coverage

README.md

@@ -13,6 +13,7 @@
 <!-- CI/CD & Quality Badges -->
 
 [![Tests](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/actions/workflows/test.yml/badge.svg)](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/Nick2bad4u/ps-color-scripts-enhanced/branch/main/graph/badge.svg)](https://codecov.io/gh/Nick2bad4u/ps-color-scripts-enhanced)
 [![Publish](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/actions/workflows/publish.yml/badge.svg)](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/actions/workflows/publish.yml)
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Nick2bad4u/PS-Color-Scripts-Enhanced/badge)](https://scorecard.dev/viewer/?uri=github.com/Nick2bad4u/PS-Color-Scripts-Enhanced)
 [![Dependency Review](https://github.com/Nick2bad4u/PS-Color-Scripts-Enhanced/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/Nick2bad4u/PS-Color-Scripts-Enhanced/actions/workflows/dependency-review.yml)
@@ -26,11 +27,15 @@
 
 <!-- License & Contributing -->
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![License: UnLicense](https://img.shields.io/badge/License-UnLicense-yellow.svg)](LICENSE)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
 
 A high-performance PowerShell module for displaying beautiful ANSI colorscripts in your terminal with intelligent caching for 6-19x faster load times.
 
+<p align="center">
+  <img src="assets/ColorScripts-Mascot-Dark.jpeg" alt="ColorScripts mascot" width="60%" />
+</p>
+
 ## Table of Contents
 
 - [Features](#features)
@@ -639,7 +644,7 @@ Contributions welcome! When adding new colorscripts:
 
 ## License
 
-MIT License – see [LICENSE](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/LICENSE) file for details
+UnLicense License – see [LICENSE](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/LICENSE) file for details
 
 ## Version History
 
@@ -668,9 +673,33 @@ See [CHANGELOG.md](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/
 ## CI/CD & Workflows
 
 - ⚙️ [Test Workflow](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/.github/workflows/test.yml)
-- 📦 [Publish Workflow](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/.github/workflows/publish.yml)
+- � [Code Coverage](https://codecov.io/gh/Nick2bad4u/ps-color-scripts-enhanced) - Automated via Codecov
+- �📦 [Publish Workflow](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/.github/workflows/publish.yml)
 - 🤖 [Dependabot Updates](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/.github/dependabot.yml)
 
+## Testing
+
+This module uses [Pester](https://pester.dev/) for testing with code coverage tracking:
+
+```powershell
+# Run all tests
+npm run test
+
+# Run tests with coverage report
+npm run test:coverage
+
+# Generate HTML coverage report (requires ReportGenerator)
+npm run test:coverage:report
+
+# Run tests directly with Pester
+Invoke-Pester -Path ./Tests
+
+# Run with coverage using the script
+./scripts/Test-Coverage.ps1 -ShowReport
+```
+
+Coverage reports are automatically uploaded to [Codecov](https://codecov.io/gh/Nick2bad4u/ps-color-scripts-enhanced) on every push.
+
 ## Support
 
 For support options, response targets, and contact channels, review the [Support Policy](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/SUPPORT.md). Bug reports and feature ideas live in the [issue tracker](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/issues).

assets/ColorScripts-Mascot-Dark.jpeg

@@ -22,6 +22,8 @@
     "test": "npm run test:custom && npm run test:pester",
     "test:custom": "pwsh -NoProfile -File ./scripts/Test-Module.ps1",
     "test:pester": "pwsh -NoProfile -Command \"Invoke-Pester -Path ./Tests\"",
+    "test:coverage": "pwsh -NoProfile -File ./scripts/Test-Coverage.ps1",
+    "test:coverage:report": "pwsh -NoProfile -File ./scripts/Test-Coverage.ps1 -ShowReport",
     "docs:update-counts": "pwsh -NoProfile -File ./scripts/Update-DocumentationCounts.ps1",
     "package:metadata": "pwsh -NoProfile -File ./scripts/Update-NuGetPackageMetadata.ps1",
     "scripts:convert": "node ./scripts/Convert-AnsiToColorScript.js",

assets/ColorScripts-Mascot.jpeg

@@ -0,0 +1,158 @@
+# Run Pester tests with code coverage
+# Generates coverage reports in multiple formats
+
+#Requires -Version 5.1
+
+[CmdletBinding()]
+param(
+    [Parameter()]
+    [switch]$ShowReport,
+
+    [Parameter()]
+    [int]$MinimumCoverage = 70,
+
+    [Parameter()]
+    [switch]$CI
+)
+
+$ErrorActionPreference = 'Stop'
+
+# Ensure Pester v5+ is available
+$pesterModule = Get-Module -ListAvailable -Name Pester | Where-Object { $_.Version -ge '5.0.0' } | Select-Object -First 1
+if (-not $pesterModule) {
+    Write-Host "Installing Pester v5..." -ForegroundColor Yellow
+    Install-Module -Name Pester -MinimumVersion 5.0.0 -Force -SkipPublisherCheck -Scope CurrentUser
+    Import-Module Pester -MinimumVersion 5.0.0 -Force
+}
+else {
+    Import-Module Pester -MinimumVersion 5.0.0 -Force
+}
+
+$repoRoot = Split-Path -Parent $PSScriptRoot
+$testsPath = Join-Path $repoRoot 'Tests'
+$modulePath = Join-Path $repoRoot 'ColorScripts-Enhanced'
+$coverageOutputPath = Join-Path $repoRoot 'coverage.xml'
+$coverageReportPath = Join-Path $repoRoot 'coverage-report'
+
+Write-Host "`n=== ColorScripts-Enhanced Code Coverage ===" -ForegroundColor Cyan
+Write-Host "Module Path: $modulePath" -ForegroundColor Gray
+Write-Host "Tests Path: $testsPath" -ForegroundColor Gray
+Write-Host "Coverage Output: $coverageOutputPath`n" -ForegroundColor Gray
+
+# Configure Pester
+$config = New-PesterConfiguration
+
+# Test discovery
+$config.Run.Path = $testsPath
+$config.Run.Exit = $CI.IsPresent
+
+# Code coverage settings
+$config.CodeCoverage.Enabled = $true
+$config.CodeCoverage.Path = @(
+    (Join-Path $modulePath 'ColorScripts-Enhanced.psm1')
+)
+$config.CodeCoverage.OutputPath = $coverageOutputPath
+$config.CodeCoverage.OutputFormat = 'JaCoCo'
+$config.CodeCoverage.CoveragePercentTarget = $MinimumCoverage
+
+# Output settings
+$config.Output.Verbosity = 'Detailed'
+
+# TestResult settings for CI
+if ($CI) {
+    $config.TestResult.Enabled = $true
+    $config.TestResult.OutputPath = Join-Path $repoRoot 'testResults.xml'
+    $config.TestResult.OutputFormat = 'NUnitXml'
+}
+
+# Run tests with coverage
+Write-Host "Running Pester tests with code coverage analysis..." -ForegroundColor Cyan
+$result = Invoke-Pester -Configuration $config
+
+# Display coverage summary
+if ($result.CodeCoverage) {
+    $coverage = $result.CodeCoverage
+    $commandsExecuted = $coverage.CommandsExecuted.Count
+    $commandsAnalyzed = $coverage.CommandsAnalyzed.Count
+
+    if ($commandsAnalyzed -gt 0) {
+        $percentage = [math]::Round(($commandsExecuted / $commandsAnalyzed) * 100, 2)
+
+        Write-Host "`n=== Code Coverage Summary ===" -ForegroundColor Cyan
+        Write-Host "Commands Covered: $commandsExecuted / $commandsAnalyzed" -ForegroundColor White
+
+        $color = if ($percentage -ge 80) { 'Green' } elseif ($percentage -ge 60) { 'Yellow' } else { 'Red' }
+        Write-Host "Coverage: $percentage%" -ForegroundColor $color
+
+        if ($coverage.MissedCommands -and $coverage.MissedCommands.Count -gt 0) {
+            Write-Host "`nTop 10 Missed Commands:" -ForegroundColor Yellow
+            $coverage.MissedCommands | Select-Object -First 10 | Format-Table File, Line, Command -AutoSize
+        }
+
+        # Check minimum coverage threshold
+        if ($percentage -lt $MinimumCoverage) {
+            Write-Warning "Coverage ($percentage%) is below minimum threshold ($MinimumCoverage%)"
+            if ($CI) {
+                exit 1
+            }
+        }
+        else {
+            Write-Host "`n✓ Coverage meets minimum threshold ($MinimumCoverage%)" -ForegroundColor Green
+        }
+    }
+}
+
+# Generate HTML report if requested
+if ($ShowReport -and (Test-Path $coverageOutputPath)) {
+    Write-Host "`nGenerating HTML coverage report..." -ForegroundColor Cyan
+
+    # Check if reportgenerator is available
+    $reportGenerator = Get-Command reportgenerator -ErrorAction SilentlyContinue
+
+    if (-not $reportGenerator) {
+        Write-Host "Installing ReportGenerator..." -ForegroundColor Yellow
+        dotnet tool install -g dotnet-reportgenerator-globaltool
+        $reportGenerator = Get-Command reportgenerator -ErrorAction SilentlyContinue
+    }
+
+    if ($reportGenerator) {
+        & reportgenerator `
+            -reports:$coverageOutputPath `
+            -targetdir:$coverageReportPath `
+            -reporttypes:Html
+
+        $indexPath = Join-Path $coverageReportPath 'index.html'
+        if (Test-Path $indexPath) {
+            Write-Host "✓ HTML report generated: $indexPath" -ForegroundColor Green
+
+            # Open in browser
+            if (-not $CI) {
+                Start-Process $indexPath
+            }
+        }
+    }
+    else {
+        Write-Warning "ReportGenerator not available. Install .NET SDK and run: dotnet tool install -g dotnet-reportgenerator-globaltool"
+    }
+}
+
+# Display test results summary
+Write-Host "`n=== Test Results Summary ===" -ForegroundColor Cyan
+Write-Host "Total Tests: $($result.TotalCount)" -ForegroundColor White
+Write-Host "Passed: $($result.PassedCount)" -ForegroundColor Green
+Write-Host "Failed: $($result.FailedCount)" -ForegroundColor $(if ($result.FailedCount -gt 0) { 'Red' } else { 'Green' })
+Write-Host "Skipped: $($result.SkippedCount)" -ForegroundColor Yellow
+
+if ($result.FailedCount -gt 0) {
+    Write-Host "`nFailed Tests:" -ForegroundColor Red
+    $result.Failed | ForEach-Object {
+        Write-Host "  - $($_.ExpandedPath)" -ForegroundColor Red
+    }
+}
+
+Write-Host ""
+
+# Exit with appropriate code
+if ($CI) {
+    exit $result.FailedCount
+}