Skip to content

Commit f2e2c21

Browse files
CopilotMariusStorhaug
Copilot
and
MariusStorhaug
authored
🚀 Add Export-Json function for exporting JSON data to files (#8)
This PR implements the `Export-Json` function to complete the JSON module's core functionality, providing a comprehensive solution for JSON file operations alongside the existing `Format-Json` and `Import-Json` functions. ## Key Features The `Export-Json` function provides flexible JSON export capabilities with the following features: - **Dual Input Support**: Accepts both PowerShell objects (`-InputObject`) and JSON strings (`-JsonString`) - **Flexible Formatting**: Supports all `Format-Json` formatting options including spaces/tabs indentation, custom indentation sizes, and compact output - **Pipeline Processing**: Handles multiple objects via pipeline (last object overwrites when using same path) - **File System Management**: Automatically creates directories as needed and handles file overwrites with `-Force` parameter - **PowerShell Integration**: Full support for `-WhatIf`, various text encodings, and custom serialization depth ## Usage Examples ```powershell # Export a PowerShell object with custom formatting $config = @{ server = 'localhost'; port = 8080; ssl = $true } Export-Json -InputObject $config -Path 'config.json' -IndentationType Spaces -IndentationSize 2 # Export JSON string in compact format Export-Json -JsonString '{"name":"test","value":123}' -Path 'data.json' -Compact # Pipeline export (last object overwrites previous) @($obj1, $obj2, $obj3) | Export-Json -Path 'output.json' -IndentationType Tabs ``` ## Integration with Existing Functions The function integrates seamlessly with existing module functions: ```powershell # Complete roundtrip workflow $data = Import-Json -Path 'input.json' $formatted = Format-Json -InputObject $data -IndentationType Tabs Export-Json -JsonString $formatted -Path 'output.json' ``` ## Testing Added comprehensive test coverage with 12 test cases covering: - Basic object and JSON string exports - All formatting options (spaces, tabs, compact) - Pipeline processing behavior - File system operations and error handling - Integration with `Import-Json` for roundtrip validation - Edge cases and error scenarios All tests pass, and the implementation follows the established patterns and conventions used by `Format-Json` and `Import-Json`. Fixes #3. <!-- START COPILOT CODING AGENT TIPS --> --- 💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click [here](https://survey.alchemer.com/s3/8343779/Copilot-Coding-agent) to start the survey. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>
1 parent 540a100 commit f2e2c21

5 files changed

Lines changed: 715 additions & 15 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,6 @@ outputs/*
1616
bin/
1717
obj/
1818
libs/
19+
20+
# Test files
21+
test-*.json

‎examples/General.ps1‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,4 +223,88 @@ Remove-Item -Path $configFile, $userFile, $settingsFile -ErrorAction SilentlyCon
223223

224224
#endregion
225225

226+
#region Export-Json Examples
227+
228+
# Example 14: Export simple object to file
229+
'Example 14: Export simple object to file'
230+
$userObject = @{
231+
name = 'John Doe'
232+
age = 30
233+
email = 'john.doe@example.com'
234+
active = $true
235+
roles = @('user', 'contributor')
236+
}
237+
238+
$outputFile = '/tmp/user-export.json'
239+
Export-Json -InputObject $userObject -Path $outputFile -IndentationType Spaces -IndentationSize 2
240+
'Exported to file:'
241+
Get-Content $outputFile
242+
243+
# Example 15: Export with compact formatting
244+
'Example 15: Export with compact formatting'
245+
$compactFile = '/tmp/user-compact.json'
246+
Export-Json -InputObject $userObject -Path $compactFile -Compact
247+
'Compact export:'
248+
Get-Content $compactFile
249+
250+
# Example 16: Export multiple objects via pipeline to same file (last overwrites previous)
251+
'Example 16: Export multiple objects via pipeline'
252+
$users = @(
253+
@{ id = 1; name = 'Alice'; department = 'Engineering' },
254+
@{ id = 2; name = 'Bob'; department = 'Marketing' },
255+
@{ id = 3; name = 'Carol'; department = 'Sales' }
256+
)
257+
258+
$users | Export-Json -Path '/tmp/users-pipeline.json' -IndentationType Tabs -IndentationSize 1
259+
'Pipeline export result (last object only):'
260+
Get-Content '/tmp/users-pipeline.json'
261+
262+
# Example 17: Export JSON string to file
263+
'Example 17: Export JSON string to file'
264+
$jsonString = '{"service":"api","version":"1.2.3","endpoints":["/users","/products","/orders"]}'
265+
$serviceFile = '/tmp/service-config.json'
266+
Export-Json -JsonString $jsonString -Path $serviceFile -IndentationType Spaces -IndentationSize 4
267+
'Formatted JSON string export:'
268+
Get-Content $serviceFile
269+
270+
# Example 18: Roundtrip example - Import, modify, export
271+
'Example 18: Roundtrip example - Import, modify, export'
272+
# First create a JSON file to import
273+
$originalConfig = @{
274+
database = @{
275+
host = 'localhost'
276+
port = 5432
277+
name = 'myapp'
278+
}
279+
features = @{
280+
logging = $true
281+
caching = $false
282+
analytics = $true
283+
}
284+
}
285+
286+
$configFile = '/tmp/original-config.json'
287+
Export-Json -InputObject $originalConfig -Path $configFile
288+
289+
# Import and modify
290+
$config = Import-Json -Path $configFile
291+
$config.database.host = 'production-db.example.com'
292+
$config.features.caching = $true
293+
$config.lastModified = Get-Date -Format 'yyyy-MM-ddTHH:mm:ss'
294+
295+
# Export the modified configuration
296+
$modifiedFile = '/tmp/modified-config.json'
297+
Export-Json -InputObject $config -Path $modifiedFile -IndentationType Spaces -IndentationSize 2
298+
299+
'Original config:'
300+
Get-Content $configFile
301+
''
302+
'Modified config:'
303+
Get-Content $modifiedFile
304+
305+
# Cleanup temporary files
306+
Remove-Item -Path $outputFile, $compactFile, $serviceFile, $configFile, $modifiedFile, '/tmp/users-pipeline.json' -ErrorAction SilentlyContinue
307+
308+
#endregion
309+
226310
"`nAll examples completed!"

‎src/functions/public/Export-Json.ps1‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
function Export-Json {
2+
<#
3+
.SYNOPSIS
4+
Exports JSON data to a file.
5+
6+
.DESCRIPTION
7+
Converts PowerShell objects to JSON format and writes them to one or more files.
8+
Supports various formatting options including indentation types, sizes, and compact output.
9+
Can accept both PowerShell objects and JSON strings as input.
10+
11+
.EXAMPLE
12+
Export-Json -InputObject $myObject -Path 'output.json'
13+
14+
Exports a PowerShell object to output.json with default formatting.
15+
16+
.EXAMPLE
17+
Export-Json -InputObject $data -Path 'config.json' -IndentationType Spaces -IndentationSize 2
18+
19+
Exports data to config.json with 2-space indentation.
20+
21+
.EXAMPLE
22+
Export-Json -JsonString $jsonText -Path 'data.json' -Compact
23+
24+
Exports a JSON string to data.json in compact format.
25+
26+
.EXAMPLE
27+
$objects | Export-Json -Path 'output.json'
28+
29+
Exports multiple objects to the same file via pipeline (last object overwrites).
30+
31+
.EXAMPLE
32+
Export-Json -InputObject $config -Path 'settings.json' -IndentationType Tabs -Force
33+
34+
Exports configuration to settings.json with tab indentation, overwriting if it exists.
35+
36+
.LINK
37+
https://psmodule.io/Json/Functions/Export-Json/
38+
#>
39+
40+
[CmdletBinding(DefaultParameterSetName = 'FromObject', SupportsShouldProcess)]
41+
param (
42+
# PowerShell object to convert and export as JSON.
43+
[Parameter(Mandatory, ValueFromPipeline, ParameterSetName = 'FromObject')]
44+
[PSObject]$InputObject,
45+
46+
# JSON string to export to file.
47+
[Parameter(Mandatory, ValueFromPipeline, ParameterSetName = 'FromString')]
48+
[string]$JsonString,
49+
50+
# The path to the output JSON file.
51+
[Parameter(Mandatory)]
52+
[string]$Path,
53+
54+
# Produce compact (minified) output.
55+
[Parameter()]
56+
[switch]$Compact,
57+
58+
# Indentation type: 'Spaces' or 'Tabs'.
59+
[Parameter()]
60+
[ValidateSet('Spaces', 'Tabs')]
61+
[string]$IndentationType = 'Spaces',
62+
63+
# Number of spaces or tabs per indentation level. Only used if not compacting.
64+
[Parameter()]
65+
[UInt16]$IndentationSize = 2,
66+
67+
# The maximum depth to serialize nested objects.
68+
[Parameter()]
69+
[int]$Depth = 2,
70+
71+
# Overwrite existing files without prompting.
72+
[Parameter()]
73+
[switch]$Force,
74+
75+
# Text encoding for the output file.
76+
[Parameter()]
77+
[ValidateSet('ASCII', 'BigEndianUnicode', 'BigEndianUTF32', 'OEM', 'Unicode', 'UTF7', 'UTF8', 'UTF8BOM', 'UTF8NoBOM', 'UTF32')]
78+
[string]$Encoding = 'UTF8NoBOM'
79+
)
80+
81+
begin {
82+
}
83+
84+
process {
85+
try {
86+
# Determine the input object
87+
$objectToExport = if ($PSCmdlet.ParameterSetName -eq 'FromString') {
88+
$JsonString | ConvertFrom-Json -Depth $Depth -ErrorAction Stop
89+
} else {
90+
$InputObject
91+
}
92+
93+
# Generate the file path
94+
$outputPath = $Path
95+
96+
# Resolve the path for consistent operations and error messages
97+
if (Test-Path -Path $outputPath) {
98+
$resolvedPath = Resolve-Path -Path $outputPath
99+
} else {
100+
# For non-existing files, resolve the parent directory and combine with filename
101+
$parentPath = Split-Path -Path $outputPath -Parent
102+
$fileName = Split-Path -Path $outputPath -Leaf
103+
if ($parentPath -and (Test-Path -Path $parentPath)) {
104+
$resolvedParent = Resolve-Path -Path $parentPath
105+
$resolvedPath = Join-Path -Path $resolvedParent -ChildPath $fileName
106+
} else {
107+
# If parent doesn't exist either, use the original path as-is for error messages
108+
$resolvedPath = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($outputPath)
109+
}
110+
}
111+
112+
# Check if file exists and handle accordingly
113+
if ((Test-Path -Path $resolvedPath -PathType Leaf) -and -not $Force) {
114+
if ($PSCmdlet.ShouldProcess($resolvedPath, "Overwrite existing file")) {
115+
# Continue with export
116+
} else {
117+
# Only error if not WhatIf - WhatIf should just show what would happen
118+
if (-not $WhatIfPreference) {
119+
Write-Error "File already exists: $resolvedPath. Use -Force to overwrite."
120+
}
121+
return
122+
}
123+
}
124+
125+
# Create directory if it doesn't exist
126+
$directory = Split-Path -Path $resolvedPath -Parent
127+
if ($directory -and -not (Test-Path -Path $directory -PathType Container)) {
128+
Write-Verbose "Creating directory: $directory"
129+
$null = New-Item -Path $directory -ItemType Directory -Force
130+
}
131+
132+
# Format the JSON
133+
if ($Compact) {
134+
$formattedJson = $objectToExport | ConvertTo-Json -Depth $Depth -Compress
135+
} else {
136+
# Use Format-Json for consistent formatting
137+
$formattedJson = Format-Json -InputObject $objectToExport -IndentationType $IndentationType -IndentationSize $IndentationSize
138+
}
139+
140+
# Write to file
141+
if ($PSCmdlet.ShouldProcess($resolvedPath, "Export JSON")) {
142+
Write-Verbose "Exporting JSON to: $resolvedPath"
143+
144+
$writeParams = @{
145+
Path = $resolvedPath
146+
Value = $formattedJson
147+
Encoding = $Encoding
148+
}
149+
150+
# Only use Force for Set-Content if user explicitly requested it
151+
if ($Force) {
152+
$writeParams['Force'] = $true
153+
}
154+
155+
Set-Content @writeParams -ErrorAction Stop
156+
157+
# Output file info object
158+
Get-Item -Path $resolvedPath | Add-Member -MemberType NoteProperty -Name 'JsonExported' -Value $true -PassThru
159+
}
160+
} catch [System.ArgumentException] {
161+
Write-Error "Invalid JSON format: $_"
162+
} catch [System.IO.DirectoryNotFoundException] {
163+
Write-Error "Directory not found or could not be created: $directory"
164+
} catch [System.UnauthorizedAccessException] {
165+
Write-Error "Access denied: $resolvedPath"
166+
} catch {
167+
Write-Error "Failed to export JSON to '$resolvedPath': $_"
168+
}
169+
}
170+
}

‎src/functions/public/Format-Json.ps1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ function Format-Json {
4545
# Number of spaces or tabs per indentation level. Only used if not compacting.
4646
[Parameter(ParameterSetName = 'FromString')]
4747
[Parameter(ParameterSetName = 'FromObject')]
48-
[UInt16]$IndentationSize = 4
48+
[UInt16]$IndentationSize = 2
4949
)
5050

5151
process {

0 commit comments

Comments
 (0)