Add IgnoreComments and AllowTrailingCommas options to Test-Json cmdlet

[ArmaanMcleod]

PR Summary

Fixes #20782

Added IgnoreComments and AllowTrailingCommas options to Test-Json -Option.

PR Context

Currently with `Test-Json it does not allow comments and trailing commas.

Given the cmdlet uses System.Text.Json we can use JsonDocumentOptions to include CommentHandling and AllowTrailingCommas.

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.
  • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
• Breaking changes
  • None
  • OR
  • Experimental feature(s) needed
    • Experimental feature name(s):
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed
    • Issue filed:
• Testing - New and feature
  • N/A or can only be tested interactively
  • OR
  • 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.
  • OR
  • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
    • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
      (which runs in a different PS Host).
      • Issue filed:
    • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
      • Issue filed:
    • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
      • Issue filed:
    • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
      • Issue filed:

[iSazonov]

I wonder why WG suggest Option as array for new parameter.
The cmdlet uses JsonNode.Parse with default JsonDocumentOption for parsing.
The JsonDocumentOption has only 3 fields and it's unbelievable that this number of parameters will be increased significantly in the future. So it would be more convenient for us to just add new individual parameters to this cmdlet as AllowTrailingCommas, CommentHandling and maybe MaxDepth.

[iSazonov]

Does ValidateSet really work for array?

[SteveL-MSFT]

Yes, https://learn.microsoft.com/en-us/powershell/scripting/developer/cmdlet/validateset-attribute-declaration?view=powershell-7.4#remarks

[iSazonov]

Since it is an array should it be Options

[ArmaanMcleod]

I wonder why WG suggest Option as array for new parameter.
The cmdlet uses JsonNode.Parse with default JsonDocumentOption for parsing.
The JsonDocumentOption has only 3 fields and it's unbelievable that this number of parameters will be increased significantly in the future. So it would be more convenient for us to just add new individual parameters to this cmdlet as AllowTrailingCommas, CommentHandling and maybe MaxDepth.

@iSazonov Yeah that was my thought as well. Given number of existing options is not much maybe converting all above options to switch parameters is cleaner. Not sure what the demand for MaxDepthis, and probably need to change how options are passed in since that one needs an integer.

[SteveL-MSFT]

LGTM

[SteveL-MSFT]

Yes, https://learn.microsoft.com/en-us/powershell/scripting/developer/cmdlet/validateset-attribute-declaration?view=powershell-7.4#remarks

[SteveL-MSFT]

I wonder why WG suggest Option as array for new parameter. The cmdlet uses JsonNode.Parse with default JsonDocumentOption for parsing. The JsonDocumentOption has only 3 fields and it's unbelievable that this number of parameters will be increased significantly in the future. So it would be more convenient for us to just add new individual parameters to this cmdlet as AllowTrailingCommas, CommentHandling and maybe MaxDepth.

@PowerShell/wg-powershell-cmdlets discussed this. The proposal for an array is that if newer options appear in the future, we don't end up with lots of different switches and having an array groups them making it clear these are options for non-standard JSON.