remark-lint-no-literal-urls
remark-lint
rule to warn for autolink literals.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Fix
- Examples
- Compatibility
- Contribute
- License
What is this?
This package is a unified (remark) plugin, specifically a remark-lint
rule. Lint rules check markdown code style.
When should I use this?
You can use this package to check that autolink literal URLs are not used.
Presets
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide | |
remark-preset-lint-recommended |
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-lint-no-literal-urls
In Deno with esm.sh
:
import remarkLintNoLiteralUrls from 'https://esm.sh/remark-lint-no-literal-urls@3'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoLiteralUrls from 'https://esm.sh/remark-lint-no-literal-urls@3?bundle'
</script>
Use
On the API:
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintNoLiteralUrls from 'remark-lint-no-literal-urls'
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await remark()
.use(remarkLint)
.use(remarkLintNoLiteralUrls)
.process(file)
console.error(reporter(file))
On the CLI:
remark --use remark-lint --use remark-lint-no-literal-urls example.md
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-literal-urls",
…
]
}
…
API
This package exports no identifiers. The default export is remarkLintNoLiteralUrls
.
unified().use(remarkLintNoLiteralUrls[, config])
This rule supports standard configuration that all remark lint rules accept (such as false
to turn it off or [1, options]
to configure it).
There are no options.
Recommendation
Autolink literal URLs (just a URL) are a feature enabled by GFM. They don’t work everywhere. Due to this, it’s recommended to instead use normal autolinks (<https://url>
) or links ([text](url)
).
Fix
remark-stringify
never creates autolink literals and always uses normal autolinks (<url>
).
Examples
ok.md
In
<http://foo.bar/baz>
Out
No messages.
not-ok.md
In
👉 Note: this example uses GFM (
remark-gfm
).
http://foo.bar/baz
Out
1:1-1:19: Don’t use literal URLs without angle brackets
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
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.