npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

markdownlint-rule-max-one-sentence-per-line

v0.0.2

Published

A custom markdownlint rule to enforce maximum one sentence per line

Downloads

1,140

Readme

markdownlint-rule-max-one-sentence-per-line

A custom markdownlint rule to enforce maximum one sentence per line.

Overview

When writing documentation, line-length often is not the most important rule. Some projects tend to ignore line-length and prefer an approach to limit each line to maximum one sentence. For example this allows:

  • easy rearranging of sentences: Most IDEs support to move whole lines with cursor keys. When there is only one sentence per line, you can easier move them around, and rearrange the structure.
  • easier detection of complicated sentence structures: If a sentence fits into one line, you can easily spot structures, which are too complicated or might need improvement.

For a better overview it often requires to split a sentence even over multiple lines, which we will not interfere with. This rule will only enforce maximum one sentence per line, but it will not rejoin sentences and adapt the structure, that one sentence will be on just one line.

Installation

Use following command to install

npm install markdownlint-rule-max-one-sentence-per-line --save-dev

Configuration

Tags: sentences

Parameters:

  • context_length: Size of context provided in error message (integer, default 14)
  • ignored_words: Words which will be ignored during the detection (string[], default ["ie","i.e","eg","e.g","etc","ex"])
  • line_endings: Recognized line-endings (string[], default [".","?","!"])
  • sentence_start: Regex for sentence start (string, default ^\s+(\w|[*_'"]))
  • indentation: Defines the used indentation (string, default ``)

Fixable: Some violations can be fixed by tooling

First sentence. Second sentence.

> First sentence. Second sentence.

* First sentence. Second sentence.

should be:

First sentence.
Second sentence.

> First sentence.
> Second sentence.

* First sentence.
  Second sentence. <!-- indentation based on provided configuration -->

Usage

For usage with certain tools, please refer to the documentation of markdownlint, markdownlint-cli or the tool you are using.