Browse / Learning Documentation / Semantic Line Breaks

Semantic Line Breaks

Applies semantic line breaks to prose, such as comments and commit messages, to improve readability and maintainability.

The source repository doesn't declare a license. Check its terms before reusing the code.

Key features

  • Defines rules for breaking lines at logical points, such as after sentences or clauses.
  • Provides specific line length limits for commit messages, code comments, and Markdown.
  • Includes best practices for handling lists, hyperlinks, and hyphenated words.
  • Enforces formatting that improves readability and simplifies version control diffs.
  • Automatically applies guidance when writing multi-line comments, commit messages, or Markdown.

Use cases

  • Writing clear and maintainable multi-line code comments.
  • Crafting well-formatted, easy-to-review Git commit messages.
  • Authoring readable and maintainable technical documentation in Markdown.