@johnzook/sentences-per-line
v0.4.1
Published
Contributed markdownlint rule for limiting sentences per line. ๐
Maintainers
Readme
Note: This is an updated fork of sentences-per-line originally created by Josh Goldberg. This fork includes bug fixes and additional features to handle a larger variety of sentence breaks.
- 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 @johnzook/sentences-per-lineThen provide it to markdownlint-cli's --rules:
markdownlint --rules @johnzook/sentences-per-lineDevelopment
See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! ๐
Credits
This package is a maintained fork of the original sentences-per-line project.
Original Contributors
๐ The original package was templated with create-typescript-app.
