remark-lint-no-auto-link-without-protocol
Deprecated.
Contents
Presets
This plugin is not included in presets maintained here.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-auto-link-without-protocol
In Deno with esm.sh:
import remarkLintNoAutoLinkWithoutProtocol from 'https://esm.sh/remark-lint-no-auto-link-without-protocol@3'
In browsers with esm.sh:
<script type="module">
import remarkLintNoAutoLinkWithoutProtocol from 'https://esm.sh/remark-lint-no-auto-link-without-protocol@3?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoAutoLinkWithoutProtocol from 'remark-lint-no-auto-link-without-protocol'
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(remarkLintNoAutoLinkWithoutProtocol)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-auto-link-without-protocol .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-auto-link-without-protocol",
…
]
}
…
API
This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoAutoLinkWithoutProtocol.
to do: remove.
Examples
ok.md
In
<http://www.example.com>
<mailto:foo@bar.com>
Most Markdown vendors don’t recognize the following as a link:
<www.example.com>
Out
No messages.
not-ok.md
In
<foo@bar.com>
Out
1:1-1:14: All automatic links must start with a protocol
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-no-auto-link-without-protocol@3, compatible with Node.js 12.
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.