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 MarkdownLint CLI checker #1366

Merged
merged 1 commit into from Feb 4, 2018

Conversation

Projects
None yet
5 participants
@dholm
Contributor

dholm commented Nov 26, 2017

Adds support for the MarkdownLint Command Line Interface based on the
Node.js markdownlint package.

@CLAassistant

This comment has been minimized.

CLAassistant commented Nov 26, 2017

CLA assistant check
All committers have signed the CLA.

@dholm dholm force-pushed the dholm:checker/markdownlint-cli branch from f4ee5f6 to f2451c5 Nov 26, 2017

@cpitclaudel

Looks very good :) Thanks! Could you add an entry in CHANGES?

@dholm dholm force-pushed the dholm:checker/markdownlint-cli branch from f2451c5 to 5d8da07 Nov 26, 2017

@dholm

This comment has been minimized.

Contributor

dholm commented Nov 26, 2017

@cpitclaudel Done!

@cpitclaudel

This comment has been minimized.

Member

cpitclaudel commented Nov 26, 2017

Thanks! One last thing: you should use .. syntax-checker-config-file instead of .. defcustom for the config file (that's what causing the build to fail)

@dholm dholm force-pushed the dholm:checker/markdownlint-cli branch from 5d8da07 to c48ca26 Nov 26, 2017

@dholm

This comment has been minimized.

Contributor

dholm commented Nov 26, 2017

Oops, fixed!

@dholm dholm force-pushed the dholm:checker/markdownlint-cli branch from c48ca26 to e361648 Nov 28, 2017

CHANGES.rst Outdated
=======================
=========================
32-cvs (in development)
=========================

This comment has been minimized.

@fmdkdd

fmdkdd Dec 9, 2017

Member

I'm not sure it was necessary to restyle every headings. But I guess it's your mode that made the change sneakily?

This comment has been minimized.

@dholm

dholm Dec 10, 2017

Contributor

Hmm, yes, I didn't even catch that myself.

This comment has been minimized.

@dholm

dholm Dec 10, 2017

Contributor

Fixed

@fmdkdd

This comment has been minimized.

Member

fmdkdd commented Dec 11, 2017

Great! We just need you to squash your commits before we can merge :)

@dholm

This comment has been minimized.

Contributor

dholm commented Dec 13, 2017

@fmdkdd Memo to self, never edit code on GitHub. :/

Add MarkdownLint CLI checker
Adds support for the MarkdownLint Command Line Interface based on the
Node.js markdownlint package.

 - https://github.com/igorshubovych/markdownlint-cli

@dholm dholm force-pushed the dholm:checker/markdownlint-cli branch from 0b8a3e5 to 3975864 Dec 13, 2017

@fmdkdd

This comment has been minimized.

Member

fmdkdd commented Dec 14, 2017

@dholm Thanks. One last thing: how does markdown-cli compare to mdl, the other linter we already have in Flycheck? I want to know if it's worth changing the default to markdown-cli, or whether we should keep mdl (because it has more lints/has better lints/is more performant/more popular or whatever).

@dholm

This comment has been minimized.

Contributor

dholm commented Dec 19, 2017

@fmdkdd I used mdl at first but had issues with suppressions not working according to the documentation, for instance disabling the line-length check for tables. markdownlint-cli appears to be better maintained and did not have these issues.

@fmdkdd

This comment has been minimized.

Member

fmdkdd commented Dec 19, 2017

@dholm I see, thank you.

@marsam You added mdl, do you have an opinion on whether we should switch to markdownlint-cli as the default checker for Markdown?

@cpitclaudel

This comment has been minimized.

Member

cpitclaudel commented Feb 4, 2018

Ping @marsam , any opinions on changing the default checker? :)

@marsam

This comment has been minimized.

Contributor

marsam commented Feb 4, 2018

Sorry for the late response, I don't have any issues with changing markdownlint-cli as default checker

@cpitclaudel cpitclaudel merged commit dff036e into flycheck:master Feb 4, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
license/cla Contributor License Agreement is signed.
Details
@cpitclaudel

This comment has been minimized.

Member

cpitclaudel commented Feb 4, 2018

@marsam Merged, thanks @dholm! (And sorry for the delay) Let's change the default checker in a separate PR. @dholm, would you like to open one?

@dholm

This comment has been minimized.

Contributor

dholm commented Feb 14, 2018

@cpitclaudel Thank you! Isn't it already the default though? I thought the order in flycheck-checkers is what makes it default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment