feat: add markdown output format to stats command

[lornajane]

What/Why/How?

I was answering a question about JSON format output containing not-JSON elements, and I also noticed #976 requesting markdown format output that could be used in other contexts, such as GitHub Job Sumaries.

So this pull request removes the output about which file is being stat-ed from being displayed by default - the stylish format keeps it as that one is human readable. The execution time output is also removed, this isn't used in all commands and breaks the other file formats such as JSON.

The pull request also adds a --format=markdown option to the stats command, to produce a markdown output. The original request was for the GitHub Job Summaries, but the format is generic markdown that could also be used elsewhere.

Example:

Feature	Count
🚗 References	39
📦 External Documents	0
📈 Schemas	22
👉 Parameters	7
🔗 Links	0
➡️ Path Items	5
👷 Operations	8
🔖 Tags	3

Check yourself

• Code is linted
• Tested with redoc/reference-docs/workflows (internal)
• All new/updated code is covered with tests

Security

• Security impact of change has been considered
• Code follows company security practices and guidelines

[changeset-bot]

🦋 Changeset detected

Latest commit: 704ba35

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@redocly/cli	Patch
@redocly/openapi-core	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

Command	Mean [s]	Min [s]	Max [s]	Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml	1.067 ± 0.009	1.051	1.076	1.00 ± 0.02
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml	1.066 ± 0.020	1.027	1.095	1.00

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	76.1%	4306/5658
🟡	Branches	65.75%	2236/3401
🟡	Functions	68.74%	695/1011
🟡	Lines	76.31%	4049/5306

Test suite run success

699 tests passing in 100 suites.

Report generated by 🧪jest coverage report action from 704ba35

[lornajane]

Note: a list rather than tables because the tables would use a helper, which would add dependencies and maybe make the output less reusable. It's up for discussion though.

[tatomyr]

Thank you for the MR! Will take a closer look at this soon.

[lornajane]

Updated to reinstate the timing output for the stylish format.

[tatomyr]

a list rather than tables

Fine by me. We can always improve the output format later.

a helper, which would add dependencies

I don't think so. It's easy to describe a table in MD format without extra helpers. All you need to do is replace this:

`- ${metric}: ${total}`

with this:

`| ${metric} | ${total} |`

Am I missing something?

[lornajane]

Hmm, maybe I should give that a go. I was taking the helper information from this article: https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/

[tatomyr]

Looks good to me. Thank you!