remark-lint-no-empty-url

remark-lint rule to warn when empty URLs are used.

Contents

What is this?
When should I use this?
Presets
Install
Use
API
- unified().use(remarkLintNoEmptyUrl)
Recommendation
Examples
Compatibility
Contribute
License

What is this?

This package checks URLs of definitions, images, and links.

When should I use this?

You can use this package to check that URLs of definitions, images, and links are not empty.

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-empty-url

In Deno with esm.sh:

import remarkLintNoEmptyUrl from 'https://esm.sh/remark-lint-no-empty-url@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoEmptyUrl from 'https://esm.sh/remark-lint-no-empty-url@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoEmptyUrl from 'remark-lint-no-empty-url'
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(remarkLintNoEmptyUrl)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-empty-url .

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-no-empty-url",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoEmptyUrl.

`unified().use(remarkLintNoEmptyUrl)`

Warn when empty URLs are used.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

While it is possible to omit URLs in links and images, that typically indicates a “placeholder” or something that has to be filled out later. It’s recommended to fill them out.

Examples

`ok.md`

In

[Mercury](https://example.com/mercury/).

![Venus](https://example.com/venus/ "Go to Venus").

[earth]: https://example.com/earth/

Out

No messages.

`not-ok.md`

In

[Mercury]().

![Venus](#).

[earth]: <>

Out

1:1-1:12: Unexpected empty link URL referencing the current document, expected URL
3:1-3:12: Unexpected empty image URL referencing the current document, expected URL
5:1-5:12: Unexpected empty definition URL referencing the current document, expected URL

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-empty-url@4, compatible with Node.js 16.

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.

License

MIT © Titus Wormer

Uh oh!