Skip to content

Contributed markdownlint rule for limiting sentences per line. 📐

License

Notifications You must be signed in to change notification settings

JoshuaKGoldberg/sentences-per-line

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sentences-per-line

Contributed markdownlint rule for limiting sentences per line. 📐

All Contributors: 2 👪 Codecov Test Coverage Contributor Covenant License: MIT Sponsor: On GitHub Style: Prettier TypeScript: Strict npm package version Contributor Covenant

- First sentence. Second sentence.
+ First sentence.
+ Second sentence.

In other words, sentences-per-line makes sure no line contains more than one sentence. This is useful because:

  • Shorter lines result in simpler, easier-to-understand Git diffs
  • Longer lines are harder to read in source code

Usage

First install this package as a devDependency:

npm i -D sentences-per-line

Then provide it to markdownlint-cli's --rules:

markdownlint --rules sentences-per-line

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md. Thanks! 💖

Contributors

Andrew Rynhard
Andrew Rynhard

🤔
Josh Goldberg
Josh Goldberg

🔧 💻 🐛 🤔 🚧 🚇

💙 This package was templated with create-typescript-app.

About

Contributed markdownlint rule for limiting sentences per line. 📐

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project