Skip to content

Conversation

@davidxia
Copy link
Contributor

@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
Contributor 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
Contributor 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
Contributor Author

gentle bump

@asottile
Copy link
Member

I mean yeah seems fine

@davidxia
Copy link
Contributor 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
Contributor 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.

@davidxia
Copy link
Contributor Author

sorry, but just wanted to bump again. 🙏

@asottile
Copy link
Member

sorry, but just wanted to bump again. 🙏

don't do this. I'll get to it when I get to it. this isn't urgent

@asottile asottile merged commit e29d2df into pre-commit:main Mar 3, 2025
2 checks passed
@davidxia davidxia deleted the patch-1 branch May 14, 2025 19:22
@davidxia davidxia changed the title docs: add igorshubovych/markdownlint-cli to hooks page docs: add DavidAnson/markdownlint-cli2 to hooks page May 14, 2025
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