Refactor Update-MDSection to simplify warning handling and remove SkipIfMissing parameter; update markdown lint rules for clarity; delete unused abbreviation-preview.js script

Author: MariusStorhaug

.github/actions/update-index/src/Helper.psm1

@@ -92,52 +92,41 @@ function Update-MDSection {
 
         # The new content to insert between the section markers.
         [Parameter()]
-        [string] $Content,
-
-        # Skip update when the target file or section markers are missing.
-        [Parameter()]
-        [switch] $SkipIfMissing
+        [string] $Content
     )
 
     $startSegment = "<!-- $Name`_START -->"
     $endSegment = "<!-- $Name`_END -->"
 
-    if (-not (Test-Path -Path $Path)) {
-        if ($SkipIfMissing) {
-            Write-Warning "[$Name] Skipping update because target file was not found: $Path"
-            return
+    function Write-UpdateWarning {
+        param([string] $Message)
+
+        Write-Warning $Message
+        if ($env:GITHUB_ACTIONS -eq 'true') {
+            Write-Output "::warning::$Message"
         }
+    }
 
-        throw "[$Name] Target file was not found: $Path"
+    if (-not (Test-Path -Path $Path)) {
+        Write-UpdateWarning "[$Name] Skipping update because target file was not found: $Path"
+        return
     }
 
     $currentContent = Get-Content -Path $Path
     $startIndex = $currentContent.IndexOf($startSegment)
     $endIndex = $currentContent.IndexOf($endSegment)
 
     if ($startIndex -lt 0) {
-        if ($SkipIfMissing) {
-            Write-Warning "[$Name] Skipping update because the start marker was not found in: $Path"
-            return
-        }
-
-        throw "[$Name] The start comment segment was not found in the file."
+        Write-UpdateWarning "[$Name] Skipping update because the start marker was not found in: $Path"
+        return
     }
     if ($endIndex -lt 0) {
-        if ($SkipIfMissing) {
-            Write-Warning "[$Name] Skipping update because the end marker was not found in: $Path"
-            return
-        }
-
-        throw "[$Name] The end comment segment was not found in the file."
+        Write-UpdateWarning "[$Name] Skipping update because the end marker was not found in: $Path"
+        return
     }
     if ($endIndex -lt $startIndex) {
-        if ($SkipIfMissing) {
-            Write-Warning "[$Name] Skipping update because marker order is invalid in: $Path"
-            return
-        }
-
-        throw "[$Name] The end comment segment was found before the start comment segment."
+        Write-UpdateWarning "[$Name] Skipping update because marker order is invalid in: $Path"
+        return
     }
 
     $updatedContent = $currentContent[0..$startIndex] + $Content + $currentContent[($endIndex)..($currentContent.Length - 1)]
@@ -202,7 +191,7 @@ function Update-ActionList {
 $actionTableRows</table>
 
 "@
-    Update-MDSection -Path '.\src\docs\GitHub-Actions\index.md' -Name 'ACTION_LIST' -Content $actionTable -SkipIfMissing
+    Update-MDSection -Path '.\src\docs\GitHub-Actions\index.md' -Name 'ACTION_LIST' -Content $actionTable
 }
 
 function Update-ModuleList {
@@ -258,7 +247,7 @@ $moduleTableRows</table>
 
 "@
 
-    Update-MDSection -Path '.\src\docs\PowerShell\Modules\index.md' -Name 'MODULE_LIST' -Content $moduleTable -SkipIfMissing
+    Update-MDSection -Path '.\src\docs\PowerShell\Modules\index.md' -Name 'MODULE_LIST' -Content $moduleTable
 }
 
 function Update-FunctionAppList {
@@ -318,5 +307,5 @@ $functionAppTableRows</table>
 
 "@
 
-    Update-MDSection -Path '.\src\docs\PowerShell\FunctionApps\index.md' -Name 'FUNCTIONAPP_LIST' -Content $functionAppTable -SkipIfMissing
+    Update-MDSection -Path '.\src\docs\PowerShell\FunctionApps\index.md' -Name 'FUNCTIONAPP_LIST' -Content $functionAppTable
 }

.github/linters/.markdown-lint.yml

@@ -8,20 +8,20 @@
 ###############
 # Rules by id #
 ###############
-MD004: false                  # Unordered list style
+MD004: false # Unordered list style
 MD007:
-  indent: 2                   # Unordered list indentation
+  indent: 2 # Unordered list indentation
 MD013:
-  line_length: 3000           # Line length
-MD025: false                  # Allow front-matter title + visible H1 on docs pages
+  line_length: 3000 # Line length
+MD025: false # Allow front-matter title + visible H1 on docs pages
 MD026:
-  punctuation: ".,;:!。，；:"    # List of not allowed
-MD029: false                  # Ordered list item prefix
-MD033: false                  # Allow inline HTML
-MD036: false                  # Emphasis used instead of a heading
-MD041: false                  # First line in file should be a top level heading, PULL_REQUEST_TEMPLATE.md is an exception
+  punctuation: '.,;:!。，；:' # List of not allowed
+MD029: false # Ordered list item prefix
+MD033: false # Allow inline HTML
+MD036: false # Emphasis used instead of a heading
+MD041: false # First line in file should be a top level heading, PULL_REQUEST_TEMPLATE.md is an exception
 
 #################
 # Rules by tags #
 #################
-blank_lines: false  # Error on blank lines
+blank_lines: false # Error on blank lines