Contributed markdownlint rule for limiting sentences per line. π
- 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
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
See .github/CONTRIBUTING.md
, then .github/DEVELOPMENT.md
.
Thanks! π
Andrew Rynhard π€ |
Josh Goldberg π§ π» π π€ π§ π |
π This package was templated with create-typescript-app.