Comparison with rumdl?

[lwjohnst86]

I've been wanting a Markdown formatter for years and now there are two new tools just this year! Really exciting 😁

Just wondering what major comparisons there are to the other formatter, rumdl? https://rumdl.dev Might be a nice source of inspiration between the two projects.

[jolars]

Thanks! Yep, looks like an interesting project, definitely. Might be good to benchmark against too. And take inspiration for lints.

Hm, at a glance:

• Panache is heavily based around Pandoc and it's flavor of markdown, and aims at full support and configuration of all its extension, and scope is (at least for now) only the set of extensions that Pandoc supports. rumdl is based around commonmark with github-flavor markdown extensions. Panache, on the other hand, support PHP Markdown, R Markdown, as well as GFM. At the moment, Panache is not fully CommonMark-compliant, however. We still use Pandoc's emphasis rules for instance. It says that rumdl has support for Quarto, but I am not sure how it is able to do this using a CommonMark-based parser, but perhaps it builds on top of that somehow.
• Currently there are many more linting rules in rumdl
• From what I can tell, the Panache's language server is more extensive at the moment.

From an internals perspective, Panache is built around a custom parser based on rowan and CST trees, which is great for language server use. rumdl uses https://github.com/pulldown-cmark/pulldown-cmark, which provides, I guess, iterators over the document tree and no direct AST. My guess is that rumdl is probably going to be faster at formatting and linting from the CI, but that Panache will be smoother when it comes to language server capabilities and also probably parse large documents faster because rowan is tailored to incremental parsing.

I'd be happy to hear about your experience too, if you've tried out both projects!

[lwjohnst86]

(sorry for not realizing this would be better placed as a discussion).

We've been using it a lot for Quarto, which we use almost entirely write in. It's been pretty good so far! There have been some small bugs/quirks, but the author has quickly resolved them. Having it integrate into pre-commit hooks and CI (as you noted) has been really helpful.

I noticed Panache uses code formatters for the code chunks. I don't believe rumdl can do that yet. So I'll give Panache a try and give some feedback on it 😁

[jolars]

Good! Yes, please do report if you find any issues or are missing some features.

[jolars]

I added some benchmarks against rumdl here: https://github.com/jolars/panache/blob/main/docs/guide/performance.qmd

[jolars]

I've uploaded the docs with much better comparisons: https://panache.bz/guide/comparison.html and https://panache.bz/guide/performance.html (for benchmarks). I hope this makes it easier to navigate the differences.