Merge pull request #164 from fscpscollaborative/develop

Release merge

Author: onikolaiev

build/format-commentbasedhelp.ps1

@@ -2,7 +2,11 @@
 # based on https://gist.github.com/Splaxi/ff7485a24f6ed9937f3e8da76b5d4840
 # See also https://github.com/fscpscollaborative/fscps.tools/wiki/Building-tools
 $path = "$PSScriptRoot\..\fscps.tools"
-
+# Path to the .psd1 file
+$psd1Path = "$path\fscps.tools.psd1"
+$psd1Data = Import-PowerShellDataFile -Path $psd1Path
+# Extract the Author field
+$author = $psd1Data.Author
 function Get-Header ($text) {
     $start = $text.IndexOf('<#')
     $temp = $start - 2
@@ -13,25 +17,76 @@ function Get-Header ($text) {
     ""
     }
 }
-
-function Format-Help ($text) {
+function Format-Help ($text) {   
+    
     $start = $text.IndexOf('<#')
     $end = $text.IndexOf('#>')
     $help = $text.SubString($start + 2, $end - $start - 3)
 
-    $skipfirst = $null # to avoid trailing spaces
+    #$skipfirst = $null # to avoid trailing spaces
+    $formattedHelp = @() # Collect formatted lines
+    $indentLevel = 0 # Track indentation level
+
+
     foreach ($newline in $help.Split("`n")) {
-        if (-not $skipfirst) { $skipfirst = $true; continue }
+        #if (-not $skipfirst) { $skipfirst = $true; continue }
         $trimmed = $newline.Trim()
-        foreach ($line in $trimmed) {
-            if ($line.StartsWith(".")) {
-                "    $line"
-            }
-            else {
-                "        $line"
-            }
+
+        # Adjust indentation based on closing braces
+        if ($trimmed -match '^\}') { $indentLevel = [math]::Max(0, $indentLevel - 1) }
+
+        if ($trimmed.StartsWith(".")) 
+        {            
+            $trimmed = "    $($trimmed.Replace("  ", ''))"
+        }
+        elseif ($trimmed.StartsWith("-")) {
+            $trimmed = "            $($trimmed.Trim())"
+        }
+        elseif ($trimmed.StartsWith("@{")) {
+            $trimmed = "            $($trimmed.Trim())"
+        }
+        else {
+            $trimmed = "        $trimmed"
+        }
+
+        # Apply indentation
+        $indentedLine = (' ' * ($indentLevel * 4)) + $trimmed
+
+        $formattedHelp += $indentedLine
+
+        # Adjust indentation based on opening braces
+        if ($trimmed -match '\{$') { $indentLevel++ }
+    }
+    $cnt = 0
+    $lines = $formattedHelp.Split("`n")
+
+    foreach ($line in $lines) {
+        if($cnt -eq 0 -and (($line -match '^[\s]*$'))) {
+            $cnt++
+            continue
+        }
+
+        # Check for .NOTES node
+        if ($line -match '\.NOTES') {
+            $foundNotes = $true
         }
+
+        # Check if the author is already present
+        if ($line -match [regex]::Escape($author)) {
+            $foundAuthor = $true
+        }
+
+        # If it's the last line and .NOTES exists but no author, add the author
+        if ($cnt -eq $lines.Length - 1 -and $foundNotes -and -not $foundAuthor) {
+            $line
+            Write-Host "Adding author to .NOTES section."
+            $line = "        Author: $author"
+        }
+
+        $line
+        $cnt++
     }
+
 }
 
 function Get-Body ($text) {
@@ -40,9 +95,9 @@ function Get-Body ($text) {
 }
 
 $files = New-Object System.Collections.ArrayList
-$filesPublic = Get-ChildItem -Path "$path\functions\*.ps1"
+$filesPublic = @(Get-ChildItem -Path "$path\functions\*.ps1")
 $files.AddRange($filesPublic)
-$filesInternal = Get-ChildItem -Path "$path\internal\functions\*.ps1"
+$filesInternal = @(Get-ChildItem -Path "$path\internal\functions\*.ps1")
 $files.AddRange($filesInternal)
 
 foreach ($file in $files) {

docs/Get-FSCPSADOAgent.md

@@ -125,5 +125,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 - The function uses the Azure DevOps REST API to retrieve agent information.
 - An authentication token is required.
 - Handles errors and interruptions gracefully.
+Author: Oleksandr Nikolaiev (@onikolaiev)
 
 ## RELATED LINKS

docs/Get-FSCPSADOTestCase.md

@@ -140,5 +140,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 - The function uses the Azure DevOps REST API to retrieve test case information.
 - An authentication token is required.
 - Handles errors and interruptions gracefully.
+Author: Oleksandr Nikolaiev (@onikolaiev)
 
 ## RELATED LINKS

docs/Get-FSCPSADOTestCasesBySuite.md

@@ -154,5 +154,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 - The function uses the Azure DevOps REST API to retrieve test cases.
 - An authentication token is required.
 - Handles errors and interruptions gracefully.
+Author: Oleksandr Nikolaiev (@onikolaiev)
 
 ## RELATED LINKS

docs/Get-FSCPSADOTestSuiteByTestCase.md

@@ -137,5 +137,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 - The function uses the Azure DevOps REST API to retrieve the test suite.
 - An authentication token is required.
 - Handles errors and interruptions gracefully.
+Author: Oleksandr Nikolaiev (@onikolaiev)
 
 ## RELATED LINKS

docs/Invoke-FSCPSAzureSignToolSignFile.md

@@ -26,11 +26,11 @@ Function to sign the files with KeyVault
 ### EXAMPLE 1
 ```
 Invoke-FSCPSAzureSignToolSignFile -Uri "https://my-vault.vault.azure.net" `
--TenantId "01234567-abcd-ef012-0000-0123456789ab" `
--CertificateName "my-key-name" `
--ClientId "01234567-abcd-ef012-0000-0123456789ab" `
--ClientSecret "secret" `
--FILE "$filePath"
+    -TenantId "01234567-abcd-ef012-0000-0123456789ab" `
+    -CertificateName "my-key-name" `
+    -ClientId "01234567-abcd-ef012-0000-0123456789ab" `
+    -ClientSecret "secret" `
+    -FILE "$filePath"
 ```
 
 This will sign the target file with the KeyVault certificate

docs/Invoke-FSCPSDigiCertSignFile.md

@@ -27,10 +27,10 @@ Function to sign the files with digicert
 ### EXAMPLE 1
 ```
 Invoke-FSCPSDigiCertSignFile -SM_API_KEY "$codeSignDigiCertAPISecretName" `
--SM_CLIENT_CERT_FILE_URL "$codeSignDigiCertUrlSecretName" `
--SM_CLIENT_CERT_PASSWORD $(ConvertTo-SecureString $codeSignDigiCertPasswordSecretName -AsPlainText -Force) `
--SM_CODE_SIGNING_CERT_SHA1_HASH "$codeSignDigiCertHashSecretName" `
--FILE "$filePath"
+    -SM_CLIENT_CERT_FILE_URL "$codeSignDigiCertUrlSecretName" `
+    -SM_CLIENT_CERT_PASSWORD $(ConvertTo-SecureString $codeSignDigiCertPasswordSecretName -AsPlainText -Force) `
+    -SM_CODE_SIGNING_CERT_SHA1_HASH "$codeSignDigiCertHashSecretName" `
+    -FILE "$filePath"
 ```
 
 This will sign the target file with the DigiCert certificate

docs/Invoke-FSCPSInstallModule.md

@@ -54,5 +54,6 @@ Accept wildcard characters: False
 ## NOTES
 - Real-time monitoring is disabled during the installation process to improve performance.
 - The "AzureRm" module is uninstalled if "Az" is specified.
+Author: Oleksandr Nikolaiev (@onikolaiev)
 
 ## RELATED LINKS

fscps.tools/fscps.tools.psd1

@@ -21,7 +21,7 @@ ModuleVersion = '1.1.332'
 GUID = '6b3d02bf-e176-4052-9b40-5012339c20b3'
 
 # Author of this module
-Author = 'Oleksandr Nikolaiev'
+Author = 'Oleksandr Nikolaiev (@onikolaiev)'
 
 # Company or vendor of this module
 CompanyName = 'Ciellos Inc.'

fscps.tools/functions/Invoke-fscpsinstallmodule.ps1

@@ -15,8 +15,9 @@
         This example installs and imports the "Az" and "Pester" modules in the current user scope.
         
     .NOTES
-        - Real-time monitoring is disabled during the installation process to improve performance.
-        - The "AzureRm" module is uninstalled if "Az" is specified.
+            - Real-time monitoring is disabled during the installation process to improve performance.
+            - The "AzureRm" module is uninstalled if "Az" is specified.
+        Author: Oleksandr Nikolaiev (@onikolaiev)
 #>
 
 function Invoke-FSCPSInstallModule {