dotnet / dotnet/sdk

Update `--cli-schema` output for consistency

Open
#49,500 0 comments 1 reaction 0 assignees View on GitHub
Area-CLI untriaged
Dominant language
C#
Stars
3.2k
Forks
1.3k
PR merge metrics
PR metrics pending

Description

@baronfel

> stylistic changes:
>
> * don't emit null values
> * don't emit empty nesting objects/maps
> * add an order property to arguments

1. I intentionally emitted `null` values as that represents a certain state. This is something that you can declare in a JSON schema.
2. I intentionally emitted empty collections/objects as we don't have a published schema and this JSON document is not being sent between a client/server. You want the structure to remain a constant so deserialization by tooling and consistency on understanding by AI would be easier since the data is more patterned if everything is always emitted.
3. In the future, let's make arguments an array so the order is preserved that way. That's a fairly easy fix.

_Originally posted by @MiYanni in https://github.com/dotnet/sdk/issues/49118#issuecomment-2981817826_

Looking at this list, the one that most impacts consumers of the JSON is the 3rd one - we should make that change before 10 GA for sure. The other two changes can definitely also happen, but they're not as structurally-impactful as #3.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.