[TypeSpec Validation] GitDiff validation rule should print user-friendly errors

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.

MIT License

2.63k stars 5.08k forks source link

[TypeSpec Validation] GitDiff validation rule should print user-friendly errors #27254

Open heaths opened 9 months ago

heaths commented 9 months ago

In Azure/azure-rest-api-specs-pr#16124 I got some GitDiff output that made me go to Azure Pipelines to review (not great; better as a GitHub message) but then was a single compressed line of JSON, which meant I had to copy it and paste it into another tool to format so I can actually read it.

Ideally, we can summarize the issues for partners directly into GitHub, but at the very least just prettifying it in Azure Pipelines would help immensely.

mikeharder commented 9 months ago

Related to #25707

ckairen commented 6 months ago

https://nodejs.org/api/util.html#utilinspectobject-options Will use this to pretty print