🚀[Feature]: Add `Import-Json` function by Copilot · Pull Request #7 · PSModule/Json

Copilot · 2025-07-25T17:52:22Z

This pull request introduces the Import-Json function to the module, enabling users to import JSON data from files into PowerShell objects. It also includes comprehensive examples and tests to demonstrate its functionality and ensure reliability.

Fixes 🚀[Feature]: Import-Json #4

New Functionality: `Import-Json`

src/functions/public/Import-Json.ps1: Added the Import-Json function, which supports importing JSON data from single or multiple files, handling pipeline input, custom depth levels, and error scenarios. It also annotates imported objects with the source file path for traceability.

Examples Update

examples/General.ps1: Expanded the examples to include detailed use cases for Import-Json, such as importing JSON from single and multiple files, pipeline usage, error handling, and combining with Format-Json.

Documentation Improvement

examples/General.ps1: Updated the file header to reflect the addition of Import-Json examples.

Comprehensive Testing

tests/Json.Tests.ps1: Added a new test context for Import-Json, covering various scenarios such as importing valid and invalid JSON files, handling empty files, using wildcards, pipeline input, custom depth levels, and relative paths. These tests ensure robustness and reliability.

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

src/functions/public/Import-Json.ps1

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

src/functions/public/Import-Json.ps1

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Copilot

Pull Request Overview

This pull request introduces the Import-Json function to the PowerShell JSON module, enabling users to import JSON data from files into PowerShell objects with comprehensive error handling and file path annotation.

Key changes include:

Added a new Import-Json function with support for single/multiple files, wildcards, pipeline input, custom depth, and source file tracking
Expanded examples to demonstrate various Import-Json use cases including error handling and integration with existing functions
Comprehensive test coverage for all function scenarios including edge cases and error conditions

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

File	Description
src/functions/public/Import-Json.ps1	Core implementation of the Import-Json function with file reading, JSON parsing, and error handling
examples/General.ps1	Added practical examples demonstrating Import-Json usage patterns and integration scenarios
tests/Json.Tests.ps1	Comprehensive test suite covering valid/invalid inputs, wildcards, pipeline usage, and error conditions

Copilot · 2025-07-25T20:35:08Z

src/functions/public/Import-Json.ps1

+                }
+            } catch [System.Management.Automation.ItemNotFoundException] {
+                Write-Error "Path not found: $filePath"
+            } catch [System.ArgumentException] {


The exception type System.ArgumentException is incorrect for JSON parsing errors. ConvertFrom-Json throws System.ArgumentException for parameter issues, but JSON parsing errors typically throw System.Management.Automation.RuntimeException or similar. This catch block may not handle JSON parsing errors as intended.

Suggested change

} catch [System.ArgumentException] {

} catch [System.Management.Automation.RuntimeException] {

Copilot · 2025-07-25T20:35:08Z

src/functions/public/Import-Json.ps1

+
+                    # Add file path information as a note property for reference
+                    if ($jsonObject -is [PSCustomObject]) {
+                        Add-Member -InputObject $jsonObject -MemberType NoteProperty -Name '_SourceFile' -Value $resolvedPath.Path -Force


This condition will fail to add the _SourceFile property when JSON represents arrays or primitive types at the root level. For example, a JSON file containing [1,2,3] or "simple string" won't get the source file annotation. Consider handling these cases or documenting this limitation.

Suggested change

Add-Member -InputObject $jsonObject -MemberType NoteProperty -Name '_SourceFile' -Value $resolvedPath.Path -Force

Add-Member -InputObject $jsonObject -MemberType NoteProperty -Name '_SourceFile' -Value $resolvedPath.Path -Force

} elseif ($jsonObject -is [Array] -or $jsonObject -is [string] -or $jsonObject -is [int] -or $jsonObject -is [bool]) {

$jsonObject = [PSCustomObject]@{ Value = $jsonObject; _SourceFile = $resolvedPath.Path }

Copilot · 2025-07-25T20:35:08Z

examples/General.ps1

+        analytics = $false
+    }
+}
+$configFile = '/tmp/config.json'


Using hardcoded Unix-style paths like '/tmp/' will fail on Windows systems. Consider using Join-Path $env:TEMP 'config.json' or [System.IO.Path]::GetTempPath() for cross-platform compatibility.

Suggested change

$configFile = '/tmp/config.json'

$configFile = Join-Path $env:TEMP 'config.json'

Copilot · 2025-07-25T20:35:08Z

examples/General.ps1

+$userFile = '/tmp/user-data.json'
+$settingsFile = '/tmp/user-settings.json'
+
+$userData | ConvertTo-Json | Set-Content -Path $userFile
+$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile
+
+# Import all user-*.json files
+$allUserData = Import-Json -Path '/tmp/user-*.json'


Using hardcoded Unix-style paths like '/tmp/' will fail on Windows systems. Consider using Join-Path $env:TEMP 'user-data.json' for cross-platform compatibility.

Suggested change

$userFile = '/tmp/user-data.json'

$settingsFile = '/tmp/user-settings.json'

$userData | ConvertTo-Json | Set-Content -Path $userFile

$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile

# Import all user-*.json files

$allUserData = Import-Json -Path '/tmp/user-*.json'

$userFile = Join-Path $env:TEMP 'user-data.json'

$settingsFile = Join-Path $env:TEMP 'user-settings.json'

$userData | ConvertTo-Json | Set-Content -Path $userFile

$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile

# Import all user-*.json files

$allUserData = Import-Json -Path (Join-Path $env:TEMP 'user-*.json')

Copilot · 2025-07-25T20:35:09Z

examples/General.ps1

+$userFile = '/tmp/user-data.json'
+$settingsFile = '/tmp/user-settings.json'
+
+$userData | ConvertTo-Json | Set-Content -Path $userFile
+$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile
+
+# Import all user-*.json files
+$allUserData = Import-Json -Path '/tmp/user-*.json'


Using hardcoded Unix-style paths like '/tmp/' will fail on Windows systems. Consider using Join-Path $env:TEMP 'user-settings.json' for cross-platform compatibility.

Suggested change

$userFile = '/tmp/user-data.json'

$settingsFile = '/tmp/user-settings.json'

$userData | ConvertTo-Json | Set-Content -Path $userFile

$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile

# Import all user-*.json files

$allUserData = Import-Json -Path '/tmp/user-*.json'

$userFile = Join-Path $env:TEMP 'user-data.json'

$settingsFile = Join-Path $env:TEMP 'user-settings.json'

$userData | ConvertTo-Json | Set-Content -Path $userFile

$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile

# Import all user-*.json files

$allUserData = Import-Json -Path (Join-Path $env:TEMP 'user-*.json')

Copilot · 2025-07-25T20:35:09Z

examples/General.ps1

+$userFile = '/tmp/user-data.json'
+$settingsFile = '/tmp/user-settings.json'
+
+$userData | ConvertTo-Json | Set-Content -Path $userFile
+$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile
+
+# Import all user-*.json files
+$allUserData = Import-Json -Path '/tmp/user-*.json'


Using hardcoded Unix-style paths like '/tmp/' will fail on Windows systems. Consider using Join-Path $env:TEMP 'user-*.json' for cross-platform compatibility.

Suggested change

$userFile = '/tmp/user-data.json'

$settingsFile = '/tmp/user-settings.json'

$userData | ConvertTo-Json | Set-Content -Path $userFile

$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile

# Import all user-*.json files

$allUserData = Import-Json -Path '/tmp/user-*.json'

$userFile = Join-Path $env:TEMP 'user-data.json'

$settingsFile = Join-Path $env:TEMP 'user-settings.json'

$userData | ConvertTo-Json | Set-Content -Path $userFile

$settingsData | ConvertTo-Json | Set-Content -Path $settingsFile

# Import all user-*.json files

$allUserData = Import-Json -Path (Join-Path $env:TEMP 'user-*.json')

Copilot · 2025-07-25T20:35:09Z

examples/General.ps1

+# Example 12: Error handling with Import-Json
+'Example 12: Error handling with Import-Json'
+try {
+    Import-Json -Path '/tmp/nonexistent.json' -ErrorAction Stop


Using hardcoded Unix-style paths like '/tmp/' will fail on Windows systems. Consider using Join-Path $env:TEMP 'nonexistent.json' for cross-platform compatibility.

Suggested change

Import-Json -Path '/tmp/nonexistent.json' -ErrorAction Stop

Import-Json -Path (Join-Path $env:TEMP 'nonexistent.json') -ErrorAction Stop

github-actions · 2025-07-25T20:38:04Z

Module Json - 1.1.0 published to the PowerShell Gallery.

github-actions · 2025-07-25T20:38:06Z

GitHub release for Json v1.1.0 has been created.

Initial plan

2393766

Copilot AI assigned Copilot and Marius Storhaug (MariusStorhaug) Jul 25, 2025

Copilot started work on behalf of Marius Storhaug (MariusStorhaug) July 25, 2025 17:52 View session

Implement Import-Json feature with comprehensive tests and examples

368a35c

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] 🚀[Feature]: Import-Json~~ 🚀 Add Import-Json function to import JSON data from files Jul 25, 2025

Copilot AI requested a review from Marius Storhaug (MariusStorhaug) July 25, 2025 18:04

Copilot finished work on behalf of Marius Storhaug (MariusStorhaug) July 25, 2025 18:04

Marius Storhaug (MariusStorhaug) requested changes Jul 25, 2025

View reviewed changes

src/functions/public/Import-Json.ps1 Outdated Show resolved Hide resolved

Copilot started work on behalf of Marius Storhaug (MariusStorhaug) July 25, 2025 19:05 View session

Move parameter documentation from help to inline comments

76f4ce6

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Copilot AI requested a review from Marius Storhaug (MariusStorhaug) July 25, 2025 19:17

Copilot finished work on behalf of Marius Storhaug (MariusStorhaug) July 25, 2025 19:17

Marius Storhaug (MariusStorhaug) requested changes Jul 25, 2025

View reviewed changes

src/functions/public/Import-Json.ps1 Outdated Show resolved Hide resolved

Copilot started work on behalf of Marius Storhaug (MariusStorhaug) July 25, 2025 19:29 View session

Update Import-Json Depth parameter to use ConvertFrom-Json default

1ef4e72

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Copilot AI requested a review from Marius Storhaug (MariusStorhaug) July 25, 2025 19:36

Copilot finished work on behalf of Marius Storhaug (MariusStorhaug) July 25, 2025 19:36

Marius Storhaug (MariusStorhaug) added 2 commits July 25, 2025 22:19

Refactor Import-Json examples and tests for consistency and clarity

3e41fbf

Fix string formatting in Import-Json examples for consistency

8748667

Marius Storhaug (MariusStorhaug) changed the title ~~🚀 Add Import-Json function to import JSON data from files~~ 🚀[Feature]: Add Import-Json function Jul 25, 2025

Marius Storhaug (MariusStorhaug) added the Minor label Jul 25, 2025

Marius Storhaug (MariusStorhaug) approved these changes Jul 25, 2025

View reviewed changes

Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 25, 2025 20:34

Copilot AI review requested due to automatic review settings July 25, 2025 20:34

Marius Storhaug (MariusStorhaug) merged commit 540a100 into main Jul 25, 2025
59 checks passed

Marius Storhaug (MariusStorhaug) deleted the copilot/fix-4 branch July 25, 2025 20:34

Copilot AI reviewed Jul 25, 2025

View reviewed changes

Marius Storhaug (MariusStorhaug) temporarily deployed to github-pages July 25, 2025 20:37 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🚀[Feature]: Add `Import-Json` function#7

🚀[Feature]: Add `Import-Json` function#7
Marius Storhaug (MariusStorhaug) merged 6 commits intomainfrom
copilot/fix-4

Copilot AI commented Jul 25, 2025 •

edited by MariusStorhaug

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

github-actions bot commented Jul 25, 2025

Uh oh!

github-actions bot commented Jul 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	} catch [System.ArgumentException] {
	} catch [System.Management.Automation.RuntimeException] {

	$configFile = '/tmp/config.json'
	$configFile = Join-Path $env:TEMP 'config.json'

	Import-Json -Path '/tmp/nonexistent.json' -ErrorAction Stop
	Import-Json -Path (Join-Path $env:TEMP 'nonexistent.json') -ErrorAction Stop

Conversation

Copilot AI commented Jul 25, 2025 • edited by MariusStorhaug Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Functionality: Import-Json

Examples Update

Documentation Improvement

Comprehensive Testing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jul 25, 2025

Uh oh!

github-actions bot commented Jul 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jul 25, 2025 •

edited by MariusStorhaug

Loading

New Functionality: `Import-Json`