Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
remark-lint-definition-spacing
Advanced tools
remark-lint rule to warn when consecutive whitespace is used in a definition
remark-lint
rule to warn when consecutive whitespace is used in
a definition label.
This package checks the whitepsace in definition labels.
GFM footnotes are not affected by this rule as footnote labels cannot contain whitespace.
You can use this package to check that definition labels are consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-definition-spacing
In Deno with esm.sh
:
import remarkLintDefinitionSpacing from 'https://esm.sh/remark-lint-definition-spacing@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintDefinitionSpacing from 'https://esm.sh/remark-lint-definition-spacing@4?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintDefinitionSpacing from 'remark-lint-definition-spacing'
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(remarkLintDefinitionSpacing)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-definition-spacing .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-definition-spacing",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintDefinitionSpacing
.
unified().use(remarkLintDefinitionSpacing)
Warn when consecutive whitespace is used in a definition label.
There are no options.
Transform (Transformer
from unified
).
Definitions and references are matched together by collapsing whitespace. Using more whitespace in labels might incorrectly indicate that they are of importance. Due to this, it’s recommended to use one space and turn this rule on.
ok.md
The first planet is [planet mercury][].
[planet mercury]: http://example.com
No messages.
not-ok-consecutive.md
[planet␠␠␠␠mercury]: http://example.com
1:1-1:40: Unexpected `4` consecutive spaces in definition label, expected `1` space, remove `3` spaces
not-ok-non-space.md
[pla␉net␊mer␍cury]: http://e.com
1:1-3:20: Unexpected non-space whitespace character `\t` in definition label, expected `1` space, replace it
1:1-3:20: Unexpected non-space whitespace character `\n` in definition label, expected `1` space, replace it
1:1-3:20: Unexpected non-space whitespace character `\r` in definition label, expected `1` space, replace it
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-definition-spacing@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 consecutive whitespace is used in a definition
The npm package remark-lint-definition-spacing receives a total of 69,091 weekly downloads. As such, remark-lint-definition-spacing popularity was classified as popular.
We found that remark-lint-definition-spacing 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
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.