Rover subgraph check --output markdown

[busches]

Description

We are currently migrating from the apollo CLI to the new rover CLI and we use the --markdown option of apollo service:check to send comments back to GitHub. I didn't see an issue tracking this feature request, outside the documentation saying it's not ready yet. https://www.apollographql.com/docs/rover/migration/#machine-readable-output

Old command for reference: https://www.npmjs.com/package/apollo#apollo-servicecheck

[EverlastingBugstopper]

Hey @busches - thanks for the report. It looks like the docs you linked here are actually a bit out of date as we do have support for --output json (though still no --output markdown).

I'm going to update the docs to point this out - there aren't any plans to include --output markdown but if there's enough interest we'll prioritize.

For now, I'd try --output json out for a spin and see if you can get some comments going, even if they aren't auto-formatted.

[busches]

We did try JSON, but the plain output for now is much easier to read, but formatted poorly, since the text table isn't a markdown table.

Hopefully the interest is there, otherwise if someone submitted a PR adding it, would you be open to it?

[EverlastingBugstopper]

We did try JSON, but the plain output for now is much easier to read, but formatted poorly, since the text table isn't a markdown table.

Have you tried piping to jq to just get portions of the data you need? I have a gist of a bash script you could use to get what you're looking for if you're interested.

Otherwise if someone submitted a PR adding it, would you be open to it?

Sure - I'd love to help with contributions. I will say that this is likely a semi-large undertaking as we'd need to add support for --output markdown for all of the other Rover commands, since --output is a global option.

If that doesn't dissuade you though, I'd recommend reading through our contributing doc and our architecture doc.

From there, you'll have to add a new possible value of Markdown to OutputType in src/cli.rs, and the compiler should help you through the rest of the refactor, but it will require well-formatted markdown for all of the possible outputs enumerated in RoverOutput in src/command/output.rs

[busches]

@EverlastingBugstopper We'll give that gist a run through, likely will do everything we want. 🎉 Probably should share that more broadly :)

[EverlastingBugstopper]

I've added the gist to both our migration guide docs and in the --output json section of the docs in #840 and also opened a new issue to track --output markdown across all commands in #843