ConvertFrom-Json: Unwrap Collections by default by danstur · Pull Request #10861 · PowerShell/PowerShell · GitHub

PR Summary

Changes the default behavior of ConvertFrom-Json to follow the usual collection-unwrapping behavior. With this change ('[1,2]' | ConvertFrom-Json | Measure-Object).Count returns 2, instead of 1.

Provides a NoEnumerate switch similar to the Write-Output command to revert to the old behavior.

See issue #3424.

PR Context

Improves the user experience for the majority of people by changing ConvertFrom-Json's behavior to match the default behavior when dealing with collections. See for example this or this stackoverflow question for examples of people falling into this trap.

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
Breaking changes
User-facing changes
- Single element Json arrays can no longer be round tripped with ConvertTo-Json.
  - Issue filed: Need to document changes to ConvertFrom-Json MicrosoftDocs/PowerShell-Docs#5101
Testing - New and feature
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.

All CLA requirements met.

/cc Michael Klement (@mklement0) Could you please review?

Looked at the failing checks.

I'm not sure what mandatory parameter I'm supposed to be passing to ConvertFrom-Json in my tests.

I can change the documentation for the new parameter, I pretty much just copied it from the Write-Output cmdlet. Starting the sentence with "Get or sets" strikes me as awkward - any proposals for the text?

Everything now looks good to me - I'm also baffled by the two Codacy failures:

Cmdlet 'ConvertFrom-Json' may be used incorrectly. Please check that all mandatory parameters are supplied.

Steve Lee (@SteveL-MSFT), since you seem to have set up Codacy, any ideas?

Adds documentation for new parameter added with PowerShell/PowerShell#10861

Codacy is probably using existing stable versions of PS as reference. Since we're adding a parameter here, we can expect it to complain.

Thanks, Rain Sallow (/u/ta11ow) (@vexx32).

It's curious that instead of complaining about an unrecognized parameter it admonishes checking for mandatory ones - but perhaps it's a catch-all message for any unrecognized syntax (can this be customized?).

I haven't participated much in code reviews, so I'm asking innocently:

Will this not keep happening?
What's the protocol when it does happen? Can it be ignored and overridden by those with merge privileges?

This particular warning seems to be a new thing, I think? I haven't seen it much until now, at least.

Codacy issues have always been considered fairly low-priority and not blocking, though -- we have Codacy completely ignoring C# at the moment as its linter isn't entirely up to speed and the newer C# features confuse it a lot.

Its PS linting is fairly good, but it's not mandatory to fix all issues -- some of them, like this one, we simply can't, after all! :slight_smile:

It's generally up to the folks reviewing whether we ask authors to fix Codacy issues, from what I've seen. 🙂

Changes the default behavior of ConvertFrom-Json to follow the usual collection-unwrapping behavior. With this change `('[1,2]' | ConvertFrom-Json | Measure-Object).Count` returns 2, instead of 1. Provides a NoEnumerate switch similar to the Write-Output command to revert to the old behavior. See issue PowerShell#3424.

Codacy failures are false positives, can be ignored.
Under Breaking changes/User-facing changes there is no link to the doc issue, so I filed a new doc issue to document changes in this PR: Need to document changes to ConvertFrom-Json MicrosoftDocs/PowerShell-Docs#5101

Daniel Sturm (@danstur) Thanks for your contribution.

Adds documentation for new parameter added with PowerShell/PowerShell#10861

🎉v7.0.0-preview.6 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

Rob Holt (rjmholt) added Breaking-Change breaking change that may affect users Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Oct 21, 2019

Ilya (iSazonov) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Oct 22, 2019

Ilya (iSazonov) reviewed Oct 24, 2019

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertFromJsonCommand.cs Outdated

Daniel Sturm (danstur) force-pushed the master branch from b2b4cd7 to 345f0a0 Compare October 24, 2019 17:54

Michael Klement (mklement0) reviewed Oct 24, 2019

View reviewed changes

Comment thread test/powershell/Modules/Microsoft.PowerShell.Utility/ConvertFrom-Json.Tests.ps1 Outdated

Daniel Sturm (danstur) force-pushed the master branch from a87850d to f1f76f0 Compare October 24, 2019 18:30

Daniel Sturm (danstur) pushed a commit to danstur/PowerShell-Docs that referenced this pull request Oct 24, 2019

ConvertFrom-Json: Add -NoEnumerate parameter

7e789f4

Adds documentation for new parameter added with PowerShell/PowerShell#10861

Daniel Sturm (danstur) mentioned this pull request Oct 24, 2019

ConvertFrom-Json: Add -NoEnumerate parameter MicrosoftDocs/PowerShell-Docs#4988

Merged

16 tasks

Travis Plunk (TravisEz13) assigned Andrew (anmenaga) Oct 24, 2019

Steve Lee (SteveL-MSFT) mentioned this pull request Oct 30, 2019

ConvertFrom-Json sends objects converted from a JSON array as an *array* through the pipeline. #3424

Closed

Steve Lee (SteveL-MSFT) requested changes Oct 30, 2019

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertFromJsonCommand.cs Outdated

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 30, 2019

Steve Lee (SteveL-MSFT) added Committee-Reviewed PS-Committee has reviewed this and made a decision and removed Breaking-Change breaking change that may affect users Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Oct 30, 2019

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Nov 9, 2019

Daniel Sturm (danstur) force-pushed the master branch from 306c2b8 to beccd62 Compare November 9, 2019 18:06

Steve Lee (SteveL-MSFT) approved these changes Nov 14, 2019

View reviewed changes

Steve Lee (SteveL-MSFT) added the Breaking-Change breaking change that may affect users label Nov 15, 2019

Andrew (anmenaga) mentioned this pull request Nov 15, 2019

Need to document changes to ConvertFrom-Json MicrosoftDocs/PowerShell-Docs#5101

Closed

10 tasks

Andrew (anmenaga) merged commit 9e02343 into PowerShell:master Nov 15, 2019

Ilya (iSazonov) added this to the 7.0.0-preview.6 milestone Nov 15, 2019

Sean Wheeler (sdwheeler) pushed a commit to MicrosoftDocs/PowerShell-Docs that referenced this pull request Nov 18, 2019

ConvertFrom-Json: Add -NoEnumerate parameter (#4988 )

3077d5b

Adds documentation for new parameter added with PowerShell/PowerShell#10861

Jordan Borean (jborean93) mentioned this pull request Dec 3, 2021

ConvertFrom-Json returns $null when parsing empty array #16548

Closed

5 tasks

coderabbitai Bot mentioned this pull request Aug 5, 2026

docs: make WSL agents invoke the Windows bridge pedropaulovc/agent-sessions-backup#114

Merged

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026

ConvertFrom-Json: Unwrap Collections by default (PowerShell#10861 )

2a6dca5

ConvertFrom-Json: Unwrap Collections by default by danstur · Pull Request #10861 · PowerShell/PowerShell · GitHub

Uh oh!

ConvertFrom-Json: Unwrap Collections by default - #10861

ConvertFrom-Json: Unwrap Collections by default#10861
Andrew (anmenaga) merged 1 commit into
PowerShell:masterfrom
danstur:master

Daniel Sturm (danstur) commented Oct 21, 2019 •
edited by anmenaga
Loading

Uh oh!

Uh oh!

Microsoft Contribution License Agreements (msftclas) commented Oct 21, 2019 •
edited
Loading

Uh oh!

Uh oh!

Ilya (iSazonov) commented Oct 22, 2019

Uh oh!

Daniel Sturm (danstur) commented Oct 24, 2019

Uh oh!

Uh oh!

Uh oh!

Michael Klement (mklement0) commented Oct 24, 2019

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) commented Oct 24, 2019

Uh oh!

Michael Klement (mklement0) commented Oct 24, 2019

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) commented Oct 24, 2019

Uh oh!

Uh oh!

Andrew (anmenaga) commented Nov 15, 2019

Uh oh!

Ilya (iSazonov) commented Nov 15, 2019

Uh oh!

Deleted user (ghost) commented Nov 21, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

ConvertFrom-Json: Unwrap Collections by default by danstur · Pull Request #10861 · PowerShell/PowerShell · GitHub

Uh oh!

ConvertFrom-Json: Unwrap Collections by default - #10861

ConvertFrom-Json: Unwrap Collections by default#10861Andrew (anmenaga) merged 1 commit intoPowerShell:masterPowerShell/PowerShell:masterfrom danstur:masterdanstur/PowerShell:masterCopy head branch name to clipboard

Conversation

Daniel Sturm (danstur) commented Oct 21, 2019 • edited by anmenaga Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

Microsoft Contribution License Agreements (msftclas) commented Oct 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ilya (iSazonov) commented Oct 22, 2019

Uh oh!

Daniel Sturm (danstur) commented Oct 24, 2019

Uh oh!

Uh oh!

Uh oh!

Michael Klement (mklement0) commented Oct 24, 2019

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) commented Oct 24, 2019

Uh oh!

Michael Klement (mklement0) commented Oct 24, 2019

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) commented Oct 24, 2019

Uh oh!

Uh oh!

Andrew (anmenaga) commented Nov 15, 2019

Uh oh!

Ilya (iSazonov) commented Nov 15, 2019

Uh oh!

Deleted user (ghost) commented Nov 21, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

ConvertFrom-Json: Unwrap Collections by default#10861
Andrew (anmenaga) merged 1 commit into
PowerShell:masterfrom
danstur:master

Daniel Sturm (danstur) commented Oct 21, 2019 •
edited by anmenaga
Loading

Microsoft Contribution License Agreements (msftclas) commented Oct 21, 2019 •
edited
Loading