Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format final counts as a table #10

Closed
mgrojo opened this issue Jan 26, 2025 · 3 comments
Closed

Format final counts as a table #10

mgrojo opened this issue Jan 26, 2025 · 3 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@mgrojo
Copy link
Contributor

mgrojo commented Jan 26, 2025

Currently, the summary counts are printed as a list:

------------------
- Failed     =  3
- Successful =  1
- Empty      =  0
- Not run    =  0

That turns into (note that the plain-text alignment is lost):


  • Failed = 3
  • Successful = 1
  • Empty = 0
  • Not run = 0

With a simple change of the output, it could be turned into a pretty table:

| Status     | Count |
|------------|-------|
| Failed     |  3
| Successful |  1
| Empty      |  0
| Not run    |  0
Status Count
Failed 3
Successful 1
Empty 0
Not run 0

By the way, a Total count could also make sense.

N.B. I see that tables are not part of the CommonMark specification, so maybe you don't want to make it less interoperable. Feel free to close this, in such case.

@LionelDraghi
Copy link
Owner

Good Idea, and it is not more difficult to parse.

(I try to stick as much as possible to CommonMarks, but table is a must have, and I won't refrain because it's not in the base standard).

@LionelDraghi LionelDraghi self-assigned this Jan 27, 2025
@LionelDraghi LionelDraghi added enhancement New feature or request good first issue Good for newcomers labels Jan 27, 2025
@mgrojo
Copy link
Contributor Author

mgrojo commented Jan 27, 2025

In fact, the table support is present in many Markdown implementations. Some time ago, I could check the basic format I used in this issue is supported by the three implementations that I was checking, namely GitHub, Pandoc and Jekyll.

@LionelDraghi
Copy link
Owner

This is the format I already use for the output of the grammar (list_grammarcommand), so it will be coherent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants