Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
remark-lint-maximum-line-length
Advanced tools
remark-lint
rule to warn when lines are too long.
This package checks the length of lines.
You can use this package to check that lines are within reason.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide | 80 |
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
:
<script type="module">
import remarkLintMaximumLineLength from 'https://esm.sh/remark-lint-maximum-line-length@4?bundle'
</script>
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",
…
]
}
…
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.
options
(number
, default: 80
)
— preferred max sizeTransform (Transformer
from unified
).
Whether to wrap prose or not is a stylistic choice.
ok.md
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 <http://localhost>.
Mercury mercury mercury mercury mercury mercury mercury mercury mercury [mercury](http://localhost).
Mercury mercury mercury mercury mercury mercury mercury mercury mercury ![mercury](http://localhost).
<div>Mercury mercury mercury mercury mercury mercury mercury mercury mercury</div>
[foo]: http://localhost/mercury/mercury/mercury/mercury/mercury/mercury/mercury/mercury
No messages.
not-ok.md
When configured with 20
.
Mercury mercury mercury
mercury.
Mercury mercury mercury `mercury()`.
Mercury mercury mercury <http://localhost>.
Mercury mercury mercury [m](example.com).
Mercury mercury mercury ![m](example.com).
`mercury()` mercury mercury mercury.
<http://localhost> mercury.
[m](example.com) mercury.
![m](example.com) mercury.
Mercury mercury ![m](example.com) mercury.
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
ok.md
When configured with 20
.
👉 Note: this example uses frontmatter (
remark-frontmatter
).
---
description: Mercury mercury mercury mercury.
---
No messages.
ok.md
When configured with 20
.
👉 Note: this example uses GFM (
remark-gfm
).
| Mercury | Mercury | Mercury |
| ------- | ------- | ------- |
No messages.
ok.md
When configured with 20
.
👉 Note: this example uses math (
remark-math
).
$$
L = \frac{1}{2} \rho v^2 S C_L
$$
No messages.
ok.md
When configured with 20
.
👉 Note: this example uses MDX (
remark-mdx
).
export const description = 'Mercury mercury mercury mercury.'
{description}
No messages.
ok-mixed-line-endings.md
When configured with 10
.
0123456789␍␊0123456789␊01234␍␊01234␊
No messages.
not-ok-mixed-line-endings.md
When configured with 10
.
012345678901␍␊012345678901␊01234567890␍␊01234567890␊
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 '🌍'
.
1:1: Unexpected value `🌍` for `options`, expected `number`
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.
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.
FAQs
remark-lint rule to warn when lines are too long
The npm package remark-lint-maximum-line-length receives a total of 0 weekly downloads. As such, remark-lint-maximum-line-length popularity was classified as not popular.
We found that remark-lint-maximum-line-length demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.