🩹 [Patch]: Use ConvertFrom-IssueForm in GitHub module (#6)

## Description

This pull request includes several changes aimed at improving script
execution and simplifying the codebase. The most important changes
include adding output visibility to scripts, updating markdown
formatting in the README, and removing redundant filters in the
PowerShell script.

Enhancements to script execution:

*
[`.github/workflows/Action-Test.yml`](diffhunk://#diff-a12ae5c885b0673c0ff6f70c2670886907590d624626e07da4c52e01aeaf56a4R32):
Added `ShowOutput: true` to display script output during the
`GetIssueFileContent` job.
*
[`action.yml`](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6R28):
Added `ShowOutput: true` to display script output during the custom
`runs` job.

Documentation improvements:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L98-R101):
Corrected the markdown formatting for the list of alternative parsers.

Codebase simplification:

*
[`scripts/main.ps1`](diffhunk://#diff-dc2e5a659836b1b73abb03421c567f5018c2755677c4a0aa764cb26117b68011R1-R17):
Removed the `Remove-MarkdownComments`, `Parse-IssueBody`, and
`Process-IssueBody` filters and replaced them with a call to
`ConvertFrom-IssueForm` for processing issue bodies.
*
[`scripts/main.ps1`](diffhunk://#diff-dc2e5a659836b1b73abb03421c567f5018c2755677c4a0aa764cb26117b68011R1-R17):
Added a `SuppressMessageAttribute` to suppress warnings about unused
parameters in the `IssueBody` variable.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

Author: MariusStorhaug

.github/workflows/Action-Test.yml

@@ -29,6 +29,7 @@ jobs:
         id: GetIssueFileContent
         uses: PSModule/GitHub-Script@v1
         with:
+          ShowOutput: true
           Script: . '.\tests\Get-IssueFileContent.ps1'
 
       - name: Action-Test

README.md

@@ -95,7 +95,7 @@ jobs:
 
 ## Alternatives
 
-[github/issue-parser](https://github.com/github/issue-parser)
-[issue-ops/parser](https://github.com/issue-ops/parser)
-[peter-murray/issue-forms-body-parser](https://github.com/peter-murray/issue-forms-body-parser)
-[peter-murray/issue-body-parser-action](https://github.com/peter-murray/issue-body-parser-action)
+- [github/issue-parser](https://github.com/github/issue-parser)
+- [issue-ops/parser](https://github.com/issue-ops/parser)
+- [peter-murray/issue-forms-body-parser](https://github.com/peter-murray/issue-forms-body-parser)
+- [peter-murray/issue-body-parser-action](https://github.com/peter-murray/issue-body-parser-action)

action.yml

@@ -25,4 +25,5 @@ runs:
       env:
         GITHUB_ACTION_INPUT_IssueBody: ${{ inputs.IssueBody }}
       with:
+        ShowOutput: true
         Script: . (Join-Path -Path '${{ github.action_path }}' -ChildPath 'scripts\main.ps1')

scripts/main.ps1

@@ -1,130 +1,19 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSReviewUnusedParameter', 'IssueBody',
+    Justification = 'Variable is used in LogGroup blocks.'
+)]
 [CmdletBinding()]
 param(
     [Parameter()]
     [string] $IssueBody = $env:GITHUB_ACTION_INPUT_IssueBody
 )
 
-filter Remove-MarkdownComments {
-    [OutputType([string])]
-    [CmdletBinding()]
-    param(
-        [Parameter(
-            Mandatory,
-            ValueFromPipeline
-        )]
-        [string] $Markdown
-    )
-    $commentPattern = '<!--[\s\S]*?-->'
-    $content = $Markdown
-    $content = $Markdown -replace $commentPattern
-    $content
-}
-
-filter Parse-IssueBody {
-    [OutputType([PSCustomObject[]])]
-    [CmdletBinding()]
-    param(
-        [Parameter(
-            Mandatory,
-            ValueFromPipeline
-        )]
-        [string] $IssueBody
-    )
-    $content = $IssueBody | Remove-MarkdownComments
-    $content = $content.Split([Environment]::NewLine).Trim() | Where-Object { $_ -ne '' }
-
-    $results = @()
-    $currentHeader = ''
-    $currentParagraph = @()
-
-    foreach ($line in $content) {
-        Write-Verbose "Processing line: [$line]"
-
-        if ($line -match '^### (.+)$') {
-            # If a new header is found, store the current header and paragraph in the results
-            if ($currentHeader -ne '') {
-                $results += [PSCustomObject]@{
-                    Header    = $currentHeader
-                    Paragraph = $currentParagraph.Trim()
-                }
-            }
-
-            # Update the newly detected header and reset the paragraph
-            $currentHeader = $matches[1]
-            $currentParagraph = @()
-        } else {
-            # Append the line to the current paragraph
-            $currentParagraph += $line
-        }
-    }
-
-    # Add the last header and paragraph to the results
-    if ($currentHeader -ne '') {
-        $results += [PSCustomObject]@{
-            Header    = $currentHeader
-            Paragraph = $currentParagraph.Trim()
-        }
-    }
-    $results | ConvertTo-Json
-}
-
-filter Process-IssueBody {
-    [OutputType([hashtable])]
-    [CmdletBinding()]
-    param(
-        [Parameter(
-            Mandatory,
-            ValueFromPipeline
-        )]
-        [string] $IssueBody
-    )
-
-    $content = $IssueBody | ConvertFrom-Json
-
-    # Initialize hashtable
-    $data = @{}
-
-    # Process each entry in the JSON
-    foreach ($entry in $content) {
-        $header = $entry.Header
-        $paragraph = $entry.Paragraph
-
-        if ($paragraph -is [string]) {
-            # Assign string value directly
-            $data[$header] = $paragraph
-        } elseif ($paragraph -is [array]) {
-            # Check if it's a multi-line string or checkbox list
-            if ($paragraph -match '^\s*- \[.\]\s') {
-                # It's a checkbox list, process as key-value pairs
-                $checkboxHashTable = @{}
-                foreach ($line in $paragraph) {
-                    if ($line -match '^\s*- \[(x| )\]\s*(.+)$') {
-                        $checked = $matches[1] -eq 'x'
-                        $item = $matches[2]
-                        $checkboxHashTable[$item] = $checked
-                    }
-                }
-                $data[$header] = $checkboxHashTable
-            } else {
-                # It's a multi-line string
-                $data[$header] = $paragraph -join [System.Environment]::NewLine
-            }
-        }
-    }
-    $data
-}
-
 LogGroup 'Issue Body - Raw' {
     Write-Output $IssueBody
 }
 
 LogGroup 'Issue Body - Object' {
-    $data = $IssueBody | Parse-IssueBody | Process-IssueBody
-    $data | Format-Table -AutoSize
-}
-
-LogGroup 'Issue Body - JSON' {
-    $data = $data | ConvertTo-Json -Compress
-    Write-Output $data
+    $data = $IssueBody | ConvertFrom-IssueForm
+    $data | Format-List
     Set-GitHubOutput -Name 'data' -Value $data
 }