Skip to content

[Story] Semantic/Sentence Linebreak Rule Option for MD013 #150

Description

@rtbs-dev

User Story

As someone that does a lot of writing in markdown (e.g. Quarto, Myst, etc.), I usually follow the recommendation to use soft-wraps and OSL (one-sentence-per-line).

I'm pretty sure there is a rule for other linters (eslint, markdownlint, prettier) that can do this, and it would be lovely to get a config option to warn/correct me when OSL has not been followed, which is a lot better than my current need to disable MD013 entirely.

Semantic linebreaks might be harder to actually implement, since there's a lot more that goes into a semantically meaningful. There are tools out there to do this, but they are...heavy, and require a bit of NLP (and the libraries that implies). See sembr.

Acceptance Criteria

  • Mode other than "off" for MD013 (line-length) to check for One-Sentence-per-Line "osl"
  • ability to perform refactor from hard-wrapped linebreaks into OSL as a code action
  • (optional) "sembr" mode that will rely on third-party semantic linebreak tooling (if available)

Additional Context

No response

Priority

Medium

Code of Conduct

  • I agree to follow this project's Code of Conduct

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    status: triageNeeds review and prioritizationtype: storyNew feature or enhancement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions