remark-lint-maximum-line-length

v4.0.1

remark-lint rule to warn when lines are too long For more information about how to use this package see README

Latest version published 7 months ago

License: MIT

NPM

GitHub

Package Health Score

70 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
4.0.1	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.1.3	\|	05/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.3	\|	07/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.2	\|	03/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.1	\|	01/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (36,288)

GitHub Stars: 898
Forks: 128
Contributors: 50

Direct Usage Popularity

The npm package remark-lint-maximum-line-length receives a total of 36,288 downloads a week. As such, we scored remark-lint-maximum-line-length popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package remark-lint-maximum-line-length, we found that it has been starred 898 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 50
Funding: Yes

With more than 10 contributors for the remark-lint-maximum-line-length repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 8
Open PR: 5
Last Release: 7 months ago
Last Commit: 10 months ago

Further analysis of the maintenance status of remark-lint-maximum-line-length based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that remark-lint-maximum-line-length demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 8 years
Dependencies: 6 Direct
Versions: 21
Install Size: 23.3 kB
Dist-tags: 1
# of Files: 5
Maintainers: 3
TS Typings: No

remark-lint-maximum-line-length has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

remark-lint-maximum-line-length

remark-lint rule to warn when lines are too long.

What is this?

This package checks the length of lines.

When should I use this?

You can use this package to check that lines are within reason.

Presets

This plugin is included in the following presets:

Preset	Options
`remark-preset-lint-markdown-style-guide`	`80`

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-maximum-line-length

In Deno with esm.sh:

import remarkLintMaximumLineLength from 'https://esm.sh/remark-lint-maximum-line-length@4'

In browsers with esm.sh:

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintMaximumLineLength from 'remark-lint-maximum-line-length'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await read('example.md')

await unified()
  .use(remarkParse)
  .use(remarkLint)
  .use(remarkLintMaximumLineLength)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-maximum-line-length .

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-maximum-line-length",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintMaximumLineLength.

`unified().use(remarkLintMaximumLineLength[, options])`

Warn when lines are too long.

Nodes that cannot be wrapped are ignored, such as JSX, HTML, code (flow), definitions, headings, and tables.

When code (phrasing), images, and links start before the wrap, end after the wrap, and contain no whitespace, they are also ignored.

Parameters

options (number, default: 80) — preferred max size

Returns

Transform (Transformer from unified).

Recommendation

Whether to wrap prose or not is a stylistic choice.

Examples

`ok.md`

In

Mercury mercury mercury mercury mercury mercury mercury mercury mercury mercury
mercury.

Mercury mercury mercury mercury mercury mercury mercury mercury mercury `mercury()`.

Mercury mercury mercury mercury mercury mercury mercury mercury mercury .

Mercury mercury mercury mercury mercury mercury mercury mercury mercury [mercury](https://localhost).

Mercury mercury mercury mercury mercury mercury mercury mercury mercury ![mercury](https://localhost).

<div>Mercury mercury mercury mercury mercury mercury mercury mercury mercury</div>

[foo]: https://localhost/mercury/mercury/mercury/mercury/mercury/mercury/mercury/mercury

Out

No messages.

`not-ok.md`

When configured with 20.

In

Mercury mercury mercury
mercury.

Mercury mercury mercury `mercury()`.

Mercury mercury mercury .

Mercury mercury mercury [m](example.com).

Mercury mercury mercury ![m](example.com).

`mercury()` mercury mercury mercury.

 mercury.

[m](example.com) mercury.

![m](example.com) mercury.

Mercury mercury ![m](example.com) mercury.

Out

1:24: Unexpected `23` character line, expected at most `20` characters, remove `3` characters
4:37: Unexpected `36` character line, expected at most `20` characters, remove `16` characters
6:44: Unexpected `43` character line, expected at most `20` characters, remove `23` characters
8:42: Unexpected `41` character line, expected at most `20` characters, remove `21` characters
10:43: Unexpected `42` character line, expected at most `20` characters, remove `22` characters
12:37: Unexpected `36` character line, expected at most `20` characters, remove `16` characters
14:28: Unexpected `27` character line, expected at most `20` characters, remove `7` characters
16:26: Unexpected `25` character line, expected at most `20` characters, remove `5` characters
18:27: Unexpected `26` character line, expected at most `20` characters, remove `6` characters
20:43: Unexpected `42` character line, expected at most `20` characters, remove `22` characters

`long-autolinks-ok.md`

When configured with 20.

In




mercury.

Mercury
.

Mercury

mercury.

Mercury

mercury mercury.

Mercury mercury

mercury mercury.

Out

No messages.

`long-autolinks-nok.md`

When configured with 20.

In

 mercury.

Mercury .

Mercury
 mercury.

Mercury 
mercury.

Out

1:37: Unexpected `36` character line, expected at most `20` characters, remove `16` characters
6:37: Unexpected `36` character line, expected at most `20` characters, remove `16` characters

`ok.md`

When configured with 20.

In

> 👉 Note: this example uses > frontmatter (remark-frontmatter).

---
description: Mercury mercury mercury mercury.
---

Out

No messages.

`ok.md`

When configured with 20.

In

> 👉 Note: this example uses > GFM (remark-gfm).

| Mercury | Mercury | Mercury |
| ------- | ------- | ------- |

Out

No messages.

`ok.md`

When configured with 20.

In

> 👉 Note: this example uses > math (remark-math).

$$
L = \frac{1}{2} \rho v^2 S C_L
$$

Out

No messages.

`ok.md`

When configured with 20.

In

> 👉 Note: this example uses > MDX (remark-mdx).

export const description = 'Mercury mercury mercury mercury.'

{description}

Out

No messages.

`ok-mixed-line-endings.md`

When configured with 10.

In

0123456789␍␊0123456789␊01234␍␊01234␊

Out

No messages.

`not-ok-mixed-line-endings.md`

When configured with 10.

In

012345678901␍␊012345678901␊01234567890␍␊01234567890␊

Out

1:13: Unexpected `12` character line, expected at most `10` characters, remove `2` characters
2:13: Unexpected `12` character line, expected at most `10` characters, remove `2` characters
3:12: Unexpected `11` character line, expected at most `10` characters, remove `1` character
4:12: Unexpected `11` character line, expected at most `10` characters, remove `1` character

`not-ok.md`

When configured with '🌍'.

Out

1:1: Unexpected value `🌍` for `options`, expected `number`

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-lint-maximum-line-length@4, compatible with Node.js 16.

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

remark-lint-maximum-line-length dependencies

@types/mdast pluralize mdast-util-mdx unified-lint-rule unist-util-position unist-util-visit

FAQs

What is remark-lint-maximum-line-length?

remark-lint rule to warn when lines are too long. Visit Snyk Advisor to see a full health score report for remark-lint-maximum-line-length, including popularity, security, maintenance & community analysis.

Is remark-lint-maximum-line-length popular?

The npm package remark-lint-maximum-line-length receives a total of 36,288 weekly downloads. As such, remark-lint-maximum-line-length popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is remark-lint-maximum-line-length well maintained?

We found indications that remark-lint-maximum-line-length maintenance is sustainable demonstrating some project activity. We saw a total of 50 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is remark-lint-maximum-line-length safe to use?

The npm package remark-lint-maximum-line-length was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 10 November-2024, at 00:03 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (36,288)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

remark-lint-maximum-line-length

Contents

What is this?

When should I use this?

Presets

Install

Use

API

unified().use(remarkLintMaximumLineLength[, options])

Parameters

Returns

Recommendation

Examples

ok.md

In

Out

not-ok.md

In

Out

long-autolinks-ok.md

In

Out

long-autolinks-nok.md

In

Out

ok.md

In

Out

ok.md

In

Out

ok.md

In

Out

ok.md

In

Out

ok-mixed-line-endings.md

In

Out

not-ok-mixed-line-endings.md

In

Out

not-ok.md

Out

Compatibility

Contribute

License

remark-lint-maximum-line-length dependencies

FAQs

What is remark-lint-maximum-line-length?

Is remark-lint-maximum-line-length popular?

Is remark-lint-maximum-line-length well maintained?

Is remark-lint-maximum-line-length safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`unified().use(remarkLintMaximumLineLength[, options])`

`ok.md`

`not-ok.md`

`long-autolinks-ok.md`

`long-autolinks-nok.md`

`ok.md`

`ok.md`

`ok.md`

`ok.md`

`ok-mixed-line-endings.md`

`not-ok-mixed-line-endings.md`

`not-ok.md`