[ENH] Add --diff option to show diff when running with --check

[tdgroot]

We use mdformat to validate Markdown formatting in a documentation project we're running. Most users are contributing to the documentation by creating changes, commits and pull requests from the Github UI, so they won't be running any linting/validation on commit. In this case, it would be very useful for those users to see what mdformat is marking as "unformatted" and knowing what should be done to fix that.

This was highly inspired by the implementation that Black uses, as it seems to doing just what we need.

Looking forward to your thoughts and review :).

[welcome]

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

[AlexanderGrooff]

Would be great to have this feature! 🚀

[tdgroot]

@hukkin any chance to get a review for this PR? :)

[hukkin]

Hi @tdgroot, thanks for contributing and sorry for the long wait!

Most users are contributing to the documentation by creating changes, commits and pull requests from the Github UI, so they won't be running any linting/validation on commit. In this case, it would be very useful for those users to see what mdformat is marking as "unformatted" and knowing what should be done to fix that.

I think you may find setting mdformat up with https://pre-commit.ci/ and pre-commit even more useful than this feature. The fixes would be automatically applied to PRs -> the contributor doesn't have to care about failures or bad formatting at all.

Regardless, I've decided to accept this feature. Do you still want to work on this or should I continue from where you left?

We should make --diff work also without --check, returning 0 also in the case there is a diff. Also mypy compains, and test coverage is not 100%.

[hukkin]

Closes #268

[tdgroot]

Hi @hukkin,

That's amazing! I'm not available to work on it this week, but I can update this PR next week I think. If that's taking too long for you, feel free to take my work and finish it :).

[Kristinita]

@tdgroot, @hukkin, is there any chances that the --diff will still be added to Mdformat?

Thanks.

[tdgroot]

@hukkin @Kristinita I finally updated the PR 😅

What do you think?