github rvben/rumdl v0.0.96

latest releases: v0.0.138, v0.0.137, v0.0.136...
one month ago

Release Notes - v0.0.96

🎉 New Features

MD013 Text Reflow/Wrapping (Experimental)

This release introduces an exciting new experimental feature for MD013 (line length rule): automatic text reflow/wrapping! This addresses issue #13 and provides intelligent line breaking while preserving Markdown formatting.

Key features of text reflow:

  • 📝 Preserves Markdown elements: Bold, italic, links, inline code, and other formatting remain intact
  • 📐 Smart list indentation: Continuation lines properly align with the text content after list markers
  • 💔 Respects hard breaks: Lines ending with two spaces are preserved as intended line breaks
  • 🚫 Selective wrapping: Code blocks, tables, headings, and reference definitions are never wrapped
  • ⚙️ Opt-in feature: Disabled by default to ensure backward compatibility

How to Enable Text Reflow

Add the following to your .rumdl.toml configuration:

[MD013]
line-length = 80
enable-reflow = true

Example

Before:

- This is a very long list item that exceeds the configured line length limit and needs to be wrapped properly

After (with 40-char limit):

- This is a very long list item that
  exceeds the configured line length
  limit and needs to be wrapped properly

🔧 Technical Details

  • Added pulldown-cmark v0.12.2 dependency for improved Markdown parsing
  • Implemented sophisticated text reflow algorithm that preserves document structure
  • Added comprehensive test coverage including unit and integration tests

⚠️ Important Notes

  • This is an experimental feature - please test thoroughly before using in production
  • The feature is disabled by default to ensure existing workflows are not affected
  • Please report any issues or unexpected behavior at https://github.com/rvben/rumdl/issues

📦 Installation

# Via pip
pip install --upgrade rumdl

# Via cargo
cargo install rumdl --version 0.0.96

# Via homebrew (macOS/Linux)
brew upgrade rumdl

🙏 Acknowledgments

Special thanks to @n8behavior who requested and provided feedback on the MD013 text wrapping feature in issue #13!

Don't miss a new rumdl release

NewReleases is sending notifications on new releases.