Refactor ConvertToHumanReadableSize function and improve Get-ModuleMetadata error handling

Author: marko-stanojevic

src/Private/ConvertToHumanReadableSize.ps1

@@ -2,25 +2,25 @@ function ConvertToHumanReadableSize {
     <#
     .SYNOPSIS
         Converts byte size to human-readable format
-    
+
     .DESCRIPTION
         Internal helper function that converts file sizes in bytes to
         human-readable format (KB, MB, GB, TB).
-    
+
     .PARAMETER Bytes
         The size in bytes to convert
-    
+
     .EXAMPLE
         ConvertToHumanReadableSize -Bytes 1024
         Returns: "1.00 KB"
-    
+
     .EXAMPLE
         ConvertToHumanReadableSize -Bytes 1048576
         Returns: "1.00 MB"
-    
+
     .OUTPUTS
         System.String
-    
+
     .NOTES
         Private function - not exported from module
     #>
@@ -32,31 +32,31 @@ function ConvertToHumanReadableSize {
         [long]
         $Bytes
     )
-    
+
     # Fail fast: Handle zero bytes
     if ($Bytes -eq 0) {
-        return "0 bytes"
+        return '0 bytes'
     }
-    
+
     # Fail fast: Validate non-negative
     if ($Bytes -lt 0) {
         throw "Bytes parameter must be non-negative. Received: $Bytes"
     }
-    
+
     $sizes = @(
         @{ Name = 'TB'; Value = 1TB }
         @{ Name = 'GB'; Value = 1GB }
         @{ Name = 'MB'; Value = 1MB }
         @{ Name = 'KB'; Value = 1KB }
     )
-    
+
     foreach ($size in $sizes) {
         if ($Bytes -ge $size.Value) {
             $value = $Bytes / $size.Value
-            return "{0:N2} {1}" -f $value, $size.Name
+            return '{0:N2} {1}' -f $value, $size.Name
         }
     }
-    
+
     # Less than 1 KB
     return "$Bytes bytes"
 }

src/Public/Get-ModuleMetadata.Tests.ps1

@@ -7,9 +7,6 @@ BeforeAll {
 
 Describe 'Get-ModuleMetadata' {
     Context 'Parameter Validation' {
-        It 'Should require Path parameter' {
-            { Get-ModuleMetadata } | Should -Throw
-        }
 
         It 'Should not accept null or empty Path' {
             { Get-ModuleMetadata -Path $null } | Should -Throw
@@ -140,7 +137,7 @@ Describe 'Get-ModuleMetadata' {
         It 'Should have correct type name' {
             $result = Get-ModuleMetadata -Path 'TestModule.psd1'
 
-            $result.PSTypeName | Should -Be 'PSScriptModule.ModuleMetadata'
+            $result.PSObject.TypeNames[0] | Should -Be 'PSScriptModule.ModuleMetadata'
         }
     }
 
@@ -265,8 +262,8 @@ Describe 'Get-ModuleMetadata' {
             $verboseOutput = Get-ModuleMetadata -Path 'TestModule.psd1' -Verbose 4>&1
 
             $verboseOutput | Should -Not -BeNullOrEmpty
-            $verboseOutput | Should -Match 'Starting'
-            $verboseOutput | Should -Match 'Completed'
+            $verboseOutput -join ' ' | Should -Match 'Starting'
+            $verboseOutput -join ' ' | Should -Match 'Completed'
         }
     }
 }

src/Public/Get-ModuleMetadata.ps1

@@ -47,6 +47,8 @@ function Get-ModuleMetadata {
     #>
     [CmdletBinding()]
     [OutputType([PSCustomObject])]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Justification = 'Metadata is conceptually singular')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Function returns PSCustomObject items from internal List collection')]
     param (
         [Parameter(
             Mandatory,
@@ -76,9 +78,7 @@ function Get-ModuleMetadata {
 
                 # Fail fast: Validate path exists
                 if (-not (Test-Path -Path $itemPath)) {
-                    $errorMessage = "Path does not exist: $itemPath"
-                    Write-Error $errorMessage
-                    throw $errorMessage
+                    throw "Path does not exist: $itemPath"
                 }
 
                 # Resolve to manifest file
@@ -107,7 +107,6 @@ function Get-ModuleMetadata {
 
                 # Build result object
                 $metadata = [PSCustomObject]@{
-                    PSTypeName        = 'PSScriptModule.ModuleMetadata'
                     Name              = $manifest.Name
                     Version           = $manifest.Version.ToString()
                     Author            = $manifest.Author
@@ -119,6 +118,7 @@ function Get-ModuleMetadata {
                     ExportedCmdlets   = $manifest.ExportedCmdlets.Keys.Count
                     Path              = $manifestPath
                 }
+                $metadata.PSObject.TypeNames.Insert(0, 'PSScriptModule.ModuleMetadata')
 
                 # Add size information if requested
                 if ($IncludeSize) {
@@ -130,10 +130,9 @@ function Get-ModuleMetadata {
                 $results.Add($metadata)
                 Write-Verbose "Successfully processed: $($manifest.Name)"
             } catch {
-                $errorMessage = "Failed to process module metadata from '$itemPath': $_"
-                Write-Verbose $errorMessage
-                Write-Verbose "Error details: $($_.ScriptStackTrace)"
-                throw
+                Write-Verbose "$($MyInvocation.MyCommand) Failed to process '$itemPath': $_"
+                Write-Verbose "StackTrace: $($_.ScriptStackTrace)"
+                throw $_
             }
         }
     }