remark-lint
rule to warn when URLs are dead.
This package checks whether URLs are alive or not.
You can use this package to check that URLs are alive.
It’s similar to remark-validate-links
,
but there’s an important difference.
That package checks the file system locally:
whether path/to/example.md
exists.
But remark-lint-no-dead-urls
checks the internet:
whether https://a.com
is alive,
/docs/example
is reachable on https://mydomain.com
,
and even whether certain IDs exist on a web page.
This package uses dead-or-alive
.
You can use it when you want to check URLs programmatically yourself.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-dead-urls
In Deno with esm.sh
:
import remarkLintNoDeadUrls from 'https://esm.sh/remark-lint-no-dead-urls@1'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoDeadUrls from 'https://esm.sh/remark-lint-no-dead-urls@1?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoDeadUrls from 'remark-lint-no-dead-urls'
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(remarkLintNoDeadUrls)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-dead-urls .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-dead-urls",
…
]
}
…
This package exports no identifiers.
It exports the additional TypeScript type
Options
.
The default export is
remarkLintNoDeadUrls
.
Configuration (TypeScript type).
deadOrAliveOptions
(Options
fromdead-or-alive
, optional) — options passed todead-or-alive
;deadOrAliveOptions.findUrls
is always off as further URLs are not used byremark-lint-no-dead-urls
from
(string
, optional, example:'https://example.com/from'
) — check relative values relative to this URL; you can also define this by settingorigin
andpathname
infile.data.meta
skipLocalhost
(boolean
, default:false
) — whether to ignorelocalhost
links such ashttp://localhost/*
,http://127.0.0.1/*
; shortcut for a skip pattern of/^(https?:\/\/)(localhost|127\.0\.0\.1)(:\d+)?/
skipOffline
(boolean
, default:false
) — whether to let offline runs pass quietlyskipUrlPatterns
(Array<RegExp | string>
, optional) — list of patterns for URLs that should be skipped; each URL will be tested against each pattern and will be ignored ifnew RegExp(pattern).test(url) === true
Warn when URLs are dead.
To improve performance,
decrease deadOrAliveOptions.maxRetries
and/or decrease the value used
for deadOrAliveOptions.sleep
.
The normal behavior is to assume connections might be flakey and to sleep a
while and retry a couple times.
If you do not care about whether anchors work and HTML redirects you can
pass deadOrAliveOptions.checkAnchor: false
and
deadOrAliveOptions.followMetaHttpEquiv: false
,
which enables a fast path without parsing HTML.
options
(Options
, optional) — configuration
Transform ((tree: Root, file: VFile) => Promise<Root>
).
remark-lint
— markdown code style linterremark-validate-links
— ensure external links are alive
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.