Use generic analyzer report directories

Author: MariusStorhaug

.github/workflows/Action-Test.yml

@@ -150,7 +150,8 @@ jobs:
           tests/Assert-ReportPaths.ps1 `
             -WorkingDirectory tests/srcTestRepo `
             -TestResultPath .PSModule/Explicit/TestResult.xml `
-            -CodeCoveragePath .PSModule/Explicit/CodeCoverage.xml
+            -CodeCoveragePath .PSModule/Explicit/CodeCoverage.xml `
+            -ArtifactDirectory .PSModule
 
   ActionTestDefaultReportPaths:
     name: Action-Test - [Default Report Paths]
@@ -178,8 +179,9 @@ jobs:
         run: |
           tests/Assert-ReportPaths.ps1 `
             -WorkingDirectory tests/srcTestRepo `
-            -TestResultPath .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml `
-            -CodeCoveragePath .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
+            -TestResultPath reports/TestResult/PSScriptAnalyzer-TestResult-Report.xml `
+            -CodeCoveragePath reports/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml `
+            -ArtifactDirectory reports
 
   ActionTestOutputs:
     name: Action-Test - [outputs]

README.md

@@ -69,11 +69,12 @@ customize rule selection, severity filtering, and custom rule inclusion.
 | `TestRegistry_Enabled`               | Enable TestRegistry.                                                           | false    |                                                     |
 
 The default report paths match the `Invoke-Pester` filename convention while
-using `.PSModule` to keep generated files out of the repository root:
+using generic `reports` directories to keep generated files out of the
+repository root:
 
 ```text
-TestResult_OutputPath: .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml
-CodeCoverage_OutputPath: .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
+TestResult_OutputPath: reports/TestResult/PSScriptAnalyzer-TestResult-Report.xml
+CodeCoverage_OutputPath: reports/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
 ```
 
 ## Outputs

action.yml

@@ -110,7 +110,7 @@ inputs:
     description: |
       Path relative to the current directory where code coverage report is saved.
     required: false
-    default: .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
+    default: reports/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
   CodeCoverage_OutputEncoding:
     description: |
       Encoding of the output file.
@@ -151,7 +151,7 @@ inputs:
     description: |
       Path relative to the current directory where test result report is saved.
     required: false
-    default: .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml
+    default: reports/TestResult/PSScriptAnalyzer-TestResult-Report.xml
   TestResult_OutputEncoding:
     description: |
       Encoding of the output file.

tests/Assert-ReportPaths.ps1

@@ -7,7 +7,10 @@ param(
     [string] $TestResultPath,
 
     [Parameter(Mandatory)]
-    [string] $CodeCoveragePath
+    [string] $CodeCoveragePath,
+
+    [Parameter(Mandatory)]
+    [string] $ArtifactDirectory
 )
 
 function Assert-ReportPath {
@@ -51,7 +54,7 @@ function Assert-ReportPath {
 }
 
 $resolvedWorkingDirectory = [System.IO.Path]::GetFullPath($WorkingDirectory)
-$artifactDirectory = Join-Path -Path $resolvedWorkingDirectory -ChildPath '.PSModule'
+$artifactDirectory = Join-Path -Path $resolvedWorkingDirectory -ChildPath $ArtifactDirectory
 
 Assert-ReportPath -Path (Join-Path -Path $resolvedWorkingDirectory -ChildPath $TestResultPath) `
     -ReportName 'test result' `