sentences-per-line

Packages to enforce the number of sentences per line in Markdown files. 📐

sentences-per-line's packages allow you to enforce that no line in your Markdown files 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 sentence. Second sentence.
+ First sentence.
+ Second sentence.

Packages

This monorepo provides:

• eslint-plugin-sentences-per-line: ESLint plugin to enforce sentences per line in Markdown files.
• markdownlint-sentences-per-line: Markdownlint rule to enforce sentences per line in Markdown files.
• prettier-plugin-sentences-per-line: Prettier plugin to enforce sentences per line in Markdown files.
• sentences-per-line: Utility functions to detect the number of sentences per line in Markdown files.

Development

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

Contributors

Andrew Rynhard 🤔

Josh Goldberg 🔧 💻 🐛 🤔 🚧 🚇

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