search

exercism / cli

A Go based command line tool for exercism.org.
https://exercism.org/docs/using/solving-exercises/working-locally
MIT License
1.34k stars 361 forks source link

Wrap output of `exercism debug` in markdown Codeblock ready to paste #869

Open NobbZ opened 5 years ago

NobbZ commented 5 years ago

We often ask to copy and paste the output of exercism debug into the gitter, some GitHub issue or the slack.

This requires students to actually know about fenced code blocks or other means of wrapping stuff before posting. Not properly wrapped output often gets reinterpreted and formatted by the rendered of the service we paste into. This often makes the output hard to read.

Therefore I suggest wrapping the output in a fenced code block making it look like this:

... Exercism debug output ...

This will be colorful when posting to GitHub as it will try to guess a language on its own and probably will not pick "plain", but gitter and slack both don't support specifying the language on the opening fence, therefore I consider this the greatest common denominator to choose from.

Downside of this is, when a student misses to copy either opening or closing fence or even a single backtick, it might blow up the complete post of that user when writing something large in GitHub.

kytrinyx commented 5 years ago

I think it's worth a try, @NobbZ !