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
Add markdown formatter #10542
Add markdown formatter #10542
Conversation
0d49aa9
to
afc3ff5
Compare
What's your use case for such a formatter? |
I made it to be able to add comments to GitHub PRs in a nice format. An additional use case could be for use with static site generators such as Jekyll. |
I still made a couple of suggestions that I think would improve the readability of the generated output. You'll also have to mention this new formatter in the docs. |
FYI - I'll be cutting a new release some time tomorrow, so we'll have to wrap this up today if you want it to make the release. |
@bbatsov thank you for the heads up about the release. I am not in a rush for this, but I do hope to pick up work on this today. Apologies for the delay! |
Thanks much for these suggestions, I think the report looks quite a bit nicer and definitely more readable! |
Thanks! |
Add a new formatter that outputs markdown. I copied the style from the existing HTML formatter so that after processing, they should be the same looking to the end user. I also added tests for this new formatter.
Before submitting the PR make sure the following are checked:
[Fix #issue-number]
(if the related issue exists).master
(if not - rebase it).bundle exec rake default
. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.md
if the new code introduces user-observable changes. See changelog entry format for details.