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

docs: add igorshubovych/markdownlint-cli to hooks page #1008

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

davidxia
Copy link

@davidxia davidxia commented Feb 7, 2025

The current Markdownlint hook is in Ruby.
Mention a popular Node-based one as well.

@asottile
Copy link
Member

asottile commented Feb 8, 2025

so I notice there's also https://github.com/DavidAnson/markdownlint-cli2 which appears to be written by the author of the underlying library

@davidxia
Copy link
Author

davidxia commented Feb 8, 2025 via email

@asottile
Copy link
Member

asottile commented Feb 8, 2025

I’m not sure the differences between them

I'd be more comfortable understanding the differences between choosing one for this page

@davidxia
Copy link
Author

davidxia commented Feb 9, 2025

A summary of the differences is here.

  • The glob implementation and handling of pattern matching is slightly different.
  • Configuration files are supported in every directory (vs. only one at the root).
  • The INI config format, .markdownlintrc, and .markdownlintignore are not supported.

A more detailed explanation is on Anson's blog here. He writes it's faster, config is more flexible, and fewer dependencies.

Based on this, I think listing Anson's is better. What do you think?

@davidxia
Copy link
Author

gentle bump

@asottile
Copy link
Member

I mean yeah seems fine

@davidxia
Copy link
Author

Thanks! Let me know next steps, if any, to get this merged.

@asottile
Copy link
Member

hmm I'm confused -- is your conclusion above that the 2 version is better?

The current Markdownlint hook is in Ruby.
Mention a popular Node-based one as well.

Signed-off-by: David Xia <david@davidxia.com>
@davidxia
Copy link
Author

davidxia commented Feb 22, 2025

hmm I'm confused -- is your conclusion above that the 2 version is better?

Oh, sorry. Forgot to update the PR. Updated now with 2.

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

Successfully merging this pull request may close these issues.

2 participants