redocly-cli icon indicating copy to clipboard operation
redocly-cli copied to clipboard

redocly lint format html or markdown

Open marianobntz opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? Please describe.

I am using redocly to generate the lint report to see warnings in an azure devops pipeline. I would like to show the lint report inside the pipeline results but I am having trouble finding a way to do it.

Any current format (1.11.0) is not suitable to upload directly so I would need to transform the report to another format and then upload.

Describe the solution you'd like

A new format for lint for markdown or html would greatly help my task. Thanks,

Describe alternatives you've considered

I am evaluating which format is more suitable for transformation but I could not find anything useful yet. Doing json to html convertion would be really difficult.

Additional context

marianobntz avatar Apr 24 '24 22:04 marianobntz

Hi @marianobntz! How would you expect the results to be formatted in the markdown format? I'm not sure, but maybe using the stats command with the --format=markdown option could be a workaround for your case?

tatomyr avatar Apr 25 '24 11:04 tatomyr

Will try it but I need the actual warnings and errors just like the codeframe format. Will let you know soon.

Thanks

marianobntz avatar Apr 25 '24 14:04 marianobntz

Just FYI... I made a powershell script to parse the redocly codeframe output and show it in Azure Devops pipeline as warnings and errors in the pipeline run.

Not sure how to add it to the cookbook or not... but I can try if you think it is worth it 😄

marianobntz avatar May 21 '24 13:05 marianobntz

That's pretty cool. Did you see that we also added a markdown output format to the lint command? It's in #1559 - merged but not released yet.

lornajane avatar May 21 '24 15:05 lornajane

yes yes, saw the PR, it would have helped with my parsing 😃 but now I like having the errors and warnings in the pipeline ... that way my analysts can see the problems pretty easily...

I will take a look at the markdown output when it is released! THANKS!

marianobntz avatar May 21 '24 18:05 marianobntz

It's in 1.13.0 onwards, so I'll close this issue since I don't think there's anything more for us to do here (but still happy to hear feedback!)

lornajane avatar Jun 04 '24 09:06 lornajane