Module/Include/MiscHelper.ps1
|
function Format-Json { <# .SYNOPSIS Prettifies JSON output. .DESCRIPTION Reformats a JSON string so the output looks better than what ConvertTo-Json outputs. .PARAMETER Json Required: [string] The JSON text to prettify. .PARAMETER Minify Optional: Returns the json string compressed. .PARAMETER Indentation Optional: The number of spaces (1..1024) to use for indentation. Defaults to 4. .PARAMETER AsArray Optional: If set, the output will be in the form of a string array, otherwise a single string is output. .EXAMPLE $json | ConvertTo-Json | Format-Json -Indentation 2 #> [CmdletBinding(DefaultParameterSetName = 'Prettify')] Param( [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)] [string]$Json, [Parameter(ParameterSetName = 'Minify')] [switch]$Minify, [Parameter(ParameterSetName = 'Prettify')] [ValidateRange(1, 1024)] [int]$Indentation = 4, [Parameter(ParameterSetName = 'Prettify')] [switch]$AsArray ) if ($PSCmdlet.ParameterSetName -eq 'Minify') { return ($Json | ConvertFrom-Json) | ConvertTo-Json -Depth 100 -Compress } # If the input JSON text has been created with ConvertTo-Json -Compress # then we first need to reconvert it without compression if ($Json -notmatch '\r?\n') { $Json = ($Json | ConvertFrom-Json) | ConvertTo-Json -Depth 100 } $indent = 0 $regexUnlessQuoted = '(?=([^"]*"[^"]*")*[^"]*$)' $result = $Json -split '\r?\n' | ForEach-Object { # If the line contains a ] or } character, # we need to decrement the indentation level unless it is inside quotes. if ($_ -match "[}\]]$regexUnlessQuoted") { $indent = [Math]::Max($indent - $Indentation, 0) } # Replace all colon-space combinations by ": " unless it is inside quotes. $line = (' ' * $indent) + ($_.TrimStart() -replace ":\s+$regexUnlessQuoted", ': ') # If the line contains a [ or { character, # we need to increment the indentation level unless it is inside quotes. if ($_ -match "[\{\[]$regexUnlessQuoted") { $indent += $Indentation } $line } #if ($AsArray) { return $result } return $result -Join [Environment]::NewLine } function Invoke-Utility { <# .SYNOPSIS Invokes an external utility, ensuring successful execution. .DESCRIPTION Invokes an external utility (program) and, if the utility indicates failure by way of a nonzero exit code, throws a script-terminating error. * Pass the command the way you would execute the command directly. * Do NOT use & as the first argument if the executable name is not a literal. .EXAMPLE Invoke-Utility git push Executes `git push` and throws a script-terminating error if the exit code is nonzero. #> $exe, $argsForExe = $Args # Workaround: Prevents 2> redirections applied to calls to this function # from accidentally triggering a terminating error. # See bug report at https://github.com/PowerShell/PowerShell/issues/4002 try { #& $exe $argsForExe >$null 2>&1 & $exe $argsForExe } catch { Throw } # catch is triggered ONLY if $exe can't be found, never for errors reported by $exe itself if (-not $?) { Write-Host $LASTEXITCODE Throw "$exe indicated failure (exit code $LASTEXITCODE; full command: $Args). $?" } } |