Validate command output is polluted by noisy messages

[cykl]

Describe the bug

Validate command supports multiple diagnostics formats.
I assume that formats like json or junit are intended to be processed by machines.

However, validate command standard output is a mix of the selected diagnostics format and informational messages.
User must parse / filter standard output to end up with the expected file.

How to Reproduce

docker run -it --rm     -v ${PWD}:/spec test asyncapi validate /spec/docs/events/asyncapi.yaml --diagnostics-format=junit  > asyncapi.xml

cat asyncapi.xml
(node:1) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)

File /spec/docs/events/asyncapi.yaml and/or referenced documents have governance issues.
<?xml version="1.0" encoding="utf-8"?>
<testsuites>
<testsuite package="org.spectral" time="0" tests="1" errors="0" failures="1" name="/spec/docs/events/asyncapi.yaml">
<testcase time="0" name="org.spectral.asyncapi-document-resolved(#/channels/hems-site-events/messages/GatewayConnectionMqttDisconnected/payloa)" classname="/spec/docs/events/asyncapi"><failure message="Property &quot;payloa&quot; is not expected to be here"><![CDATA[line 94, col 16, Property "payloa" is not expected to be here (asyncapi-document-resolved) at path #/channels/site-events/messages/GatewayConnectionMqttDisconnected/payloa]]></failure></testcase>
</testsuite>
</testsuites>

Expected behavior

It would be nice to separate command logs from actual output.
Those options could work:

• Add an optional outputFile parameter
• Add an optional silent parameter

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[Shurtu-gal]

Regarding silent parameter the current validate command already has a boolean flag log-diagnostics. The output file is a valid addition. Thanks for giving this idea 🤗

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[Amzani]

still relevant

[dhruvilmehta]

Currently, it's printing the XML in the command line. XML file should contain the following that is printed in the terminal right? It should only contain pure XML and not the diagnostics logs, right?

[Shurtu-gal]

Yeah, output-file param will become more and more necessary as we do more UI/UX improvements.
WDYT @Amzani ?

[sushilpandeyy]

@Souvikns Could you please assign this issue to me? Thank you!