Skip to content

Latest commit

 

History

History
83 lines (66 loc) · 3.97 KB

README.md

File metadata and controls

83 lines (66 loc) · 3.97 KB
Raw

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.