Skip to content

Add -AsArray parameter to ConvertoTo-Json command #6438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 6 commits into from
Mar 23, 2018
Merged

Add -AsArray parameter to ConvertoTo-Json command #6438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6c8a6ae
Add -AsArray parameter to ConvertoTo-Json command to always pack the …
kalgiz Mar 20, 2018
d527cba
Tests correction for -AsArray parameter in ConvertTo-Json command.
kalgiz Mar 20, 2018
69f6da4
Merge branch 'master' of https://github.com/kalgiz/PowerShell into co…
kalgiz Mar 21, 2018
e8e7bda
ConvertToJson command code cleanup
kalgiz Mar 21, 2018
088ccb5
Merge branch 'master' of https://github.com/kalgiz/PowerShell into co…
kalgiz Mar 22, 2018
9044d32
Comment correction.
kalgiz Mar 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,18 @@ public class ConvertToJsonCommand : PSCmdlet
/// be converted to their string equivalent. Otherwise, enum values
/// will be converted to their numeric equivalent.
/// </summary>
[Parameter()]
[Parameter]
public SwitchParameter EnumsAsStrings { get; set; }

/// <summary>
/// Gets or sets the AsArray property.
/// If the AsArray property is set to be true, the result JSON string will
/// be returned with surrounding '[', ']' chars. Otherwise,
/// the array symbols will occur only if there is more than one input object.
/// </summary>
[Parameter]
public SwitchParameter AsArray { get; set; }

#endregion parameters

#region overrides
Expand Down Expand Up @@ -104,7 +113,7 @@ protected override void EndProcessing()
{
if (_inputObjects.Count > 0)
{
object objectToProcess = (_inputObjects.Count > 1) ? (_inputObjects.ToArray() as object) : (_inputObjects[0]);
object objectToProcess = (_inputObjects.Count > 1 || AsArray) ? (_inputObjects.ToArray() as object) : (_inputObjects[0]);
// Pre-process the object so that it serializes the same, except that properties whose
// values cannot be evaluated are treated as having the value null.
object preprocessedObject = null;
Expand Down
13 changes: 13 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/ConvertTo-Json.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,17 @@ Describe 'ConvertTo-Json' -tags "CI" {
$ps.InvocationStateInfo.State | Should -BeExactly "Stopped"
$ps.Dispose()
}

It "The result string is packed in an array symbols when AsArray parameter is used." {
$output = 1 | ConvertTo-Json -AsArray
$output | Should -BeLike "``[*1*]"

$output = 1,2 | ConvertTo-Json -AsArray
$output | Should -BeLike "``[*1*2*]"
}

It "The result string is not packed in the array symbols when there is only one input object and AsArray parameter is not used." {
$output = 1 | ConvertTo-Json
$output | Should -BeExactly '1'
}
}