Package Exports

remark-lint-maximum-line-length

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-maximum-line-length) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-lint-maximum-line-length

Warn when lines are too long.

Options: number, default: 80.

Ignores nodes that cannot be wrapped, such as headings, tables, code, and definitions.

Ignores images, links, and inline code if they start before the wrap, end after the wrap, and there’s no white-space after them.

Presets

This rule is included in the following presets:

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

Example

`valid-mixed-line-endings.md`

When configured with 10.

In

Note: ␍␊ represents a carriage return and a line feed.

Note: ␊ represents a line feed.

0123456789␍␊
0123456789␊
01234␍␊
01234␊

Out

No messages.

`invalid-mixed-line-endings.md`

When configured with 10.

In

Note: ␍␊ represents a carriage return and a line feed.

Note: ␊ represents a line feed.

012345678901␍␊
012345678901␊
01234567890␍␊
01234567890␊

Out

1:13: Line must be at most 10 characters
2:13: Line must be at most 10 characters
3:12: Line must be at most 10 characters
4:12: Line must be at most 10 characters

`invalid.md`

When configured with 80.

In

This line is simply not tooooooooooooooooooooooooooooooooooooooooooooooooooooooo
long.

Just like thiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiis one.

And this one is also very wrong: because the link starts aaaaaaafter the column: <http://line.com>

<http://this-long-url-with-a-long-domain-is-invalid.co.uk/a-long-path?query=variables> and such.

And this one is also very wrong: because the code starts aaaaaaafter the column: `alpha.bravo()`

`alphaBravoCharlieDeltaEchoFoxtrotGolfHotelIndiaJuliettKiloLimaMikeNovemberOscar.papa()` and such.

Out

4:86: Line must be at most 80 characters
6:99: Line must be at most 80 characters
8:97: Line must be at most 80 characters
10:97: Line must be at most 80 characters
12:99: Line must be at most 80 characters

`valid.md`

In

This line is simply not toooooooooooooooooooooooooooooooooooooooooooo
long.

This is also fine: <http://this-long-url-with-a-long-domain.co.uk/a-long-path?query=variables>

<http://this-link-is-fine.com>

`alphaBravoCharlieDeltaEchoFoxtrotGolfHotelIndiaJuliettKiloLimaMikeNovemberOscarPapaQuebec.romeo()`

[foo](http://this-long-url-with-a-long-domain-is-valid.co.uk/a-long-path?query=variables)

<http://this-long-url-with-a-long-domain-is-valid.co.uk/a-long-path?query=variables>

![foo](http://this-long-url-with-a-long-domain-is-valid.co.uk/a-long-path?query=variables)

| An | exception | is | line | length | in | long | tables | because | those | can’t | just |
| -- | --------- | -- | ---- | ------ | -- | ---- | ------ | ------- | ----- | ----- | ---- |
| be | helped    |    |      |        |    |      |        |         |       |       | .    |

The following is also fine, because there is no white-space.

<http://this-long-url-with-a-long-domain-is-invalid.co.uk/a-long-path?query=variables>.

In addition, definitions are also fine:

[foo]: <http://this-long-url-with-a-long-domain-is-invalid.co.uk/a-long-path?query=variables>

Out

No messages.

Install

npm install remark-lint-maximum-line-length

Usage

You probably want to use it on the CLI through a config file:

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

Or use it on the CLI directly

remark -u lint -u lint-maximum-line-length readme.md

Or use this on the API:

 var remark = require('remark');
 var report = require('vfile-reporter');

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-maximum-line-length'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });