Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

sentences-per-line

JoshuaKGoldberg60.4kMIT0.3.0TypeScript support: included

Contributed markdownlint rule for limiting sentences per line. 📐

line, lint, markdown, markdownlint-rule, markdownlint, per, sentences

readme

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.

changelog

0.2.2 (2024-12-13)

Bug Fixes

  • explicitly indicate parser: none (72d28b8)

Changelog

1.27.12 (2022-12-31)

1.27.11 (2022-12-29)

1.27.10 (2022-12-26)

1.27.9 (2022-12-26)

Bug Fixes

1.27.8 (2022-12-25)

1.27.7 (2022-12-24)

1.27.6 (2022-12-24)

1.27.5 (2022-12-24)

Bug Fixes

1.27.4 (2022-12-24)

1.27.3 (2022-12-23)

1.27.2 (2022-12-23)

1.27.1 (2022-12-23)

1.27.0 (2022-12-23)

Features

  • document 145, and re-add npm publishing (4df06c6)

1.26.0 (2022-12-23)

Features

  • fix typo in pnpm description (e1a21fc)
  • re-add branch protection toggling in release.yml (#144) (b55395a)
  • skip npm publish (just for testing (14dc939)
  • try adding back benjefferies/branch-protection-bot (7e12306)
  • use Octokit to populate more settings (#130) (ff33d79)

Bug Fixes

1.22.1 (2022-12-20)

Bug Fixes

  • only append README.md notice once in setup (#131) (bd2901d)

1.22.0 (2022-12-15)

Features

1.21.0 (2022-12-15)

Features

  • clear CHANGELOG.md and local Git tags in setup (#125) (9ed5f45)

1.20.2 (2022-12-15)

Bug Fixes

  • corrected allcontributors setup import path with fs (#124) (2506907)

1.20.1 (2022-12-15)

Bug Fixes

  • corrected description quote in setup script (#123) (1360510)

1.20.0 (2022-12-15)

Features

  • add 'area: testing' label to setup data (#120) (e0f9e0b)

1.19.0 (2022-12-15)

Features

  • bind console.log always to the same value (#111) (c62dc71)
  • remove branch protection bot from release.yml (c8b5e2b)
  • set back release.yml (27fa842)
  • testing out package version 1.14.0 bump (69e2617)

Bug Fixes

  • temporarily disable branch protections for release-it (#113) (e4c41b8)

1.8.0 (2022-12-14)

Features

  • switch from semantic-release to release-it (#110) (c0fcbf4)

1.7.0 (2022-12-14)

Features

  • used semantic-release/exec to clean changelog headings (#109) (db88e12)

1.6.0 (2022-12-13)

Features

  • change GHANGELOG.md title to include hash (297eb4e)

1.5.0 (2022-12-13)

Features

  • add test entry to CHANGELOG.md (c39b3db)

1.4.0 (2022-12-13)

Features

  • bind console log for performance (not really) (#105) (98155c5)