Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshuakgoldberg/sentences-per-line
Contributed markdownlint rule for limiting sentences per line. 📐
https://github.com/joshuakgoldberg/sentences-per-line
lint markdown markdownlint markdownlint-rule sentences
Last synced: about 1 month ago
JSON representation
Contributed markdownlint rule for limiting sentences per line. 📐
- Host: GitHub
- URL: https://github.com/joshuakgoldberg/sentences-per-line
- Owner: JoshuaKGoldberg
- License: mit
- Created: 2023-08-19T01:10:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-19T23:27:00.000Z (about 1 month ago)
- Last Synced: 2024-12-20T00:25:22.299Z (about 1 month ago)
- Topics: lint, markdown, markdownlint, markdownlint-rule, sentences
- Language: TypeScript
- Homepage:
- Size: 2.04 MB
- Stars: 9
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
sentences-per-line
Contributed markdownlint rule for limiting sentences per line. 📐
```diff
- 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:
```shell
npm i -D sentences-per-line
```
Then provide it to [markdownlint-cli's `--rules`](https://github.com/igorshubovych/markdownlint-cli):
```shell
markdownlint --rules sentences-per-line
```
## Development
See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
Thanks! 💖
## Contributors
Andrew Rynhard
🤔
Josh Goldberg
🔧 💻 🐛 🤔 🚧 🚇
> 💙 This package was templated with [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).