remark-lint-correct-media-syntax

remark-lint-correct-media-syntax

remark-lint rule to warn for accidental bracket and paren mixup for images and links.

Contents

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

What is this?

This package checks for accidental image or link mixup: (text)[url] instead of [text](url).

When should I use this?

You can use this package to check that brackets and parentheses that are used to form image and links are not accidentally swapped.

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-correct-media-syntax

In Deno with esm.sh:

import remarkLintCorrectMediaSyntax from 'https://esm.sh/remark-lint-correct-media-syntax@1'

In browsers with esm.sh:

<script type="module">
  import remarkLintCorrectMediaSyntax from 'https://esm.sh/remark-lint-correct-media-syntax@1?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintCorrectMediaSyntax from 'remark-lint-correct-media-syntax'
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(remarkLintCorrectMediaSyntax)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-correct-media-syntax .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-correct-media-syntax",
     …
   ]
 }
 …

API

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

unified().use(remarkLintCorrectMediaSyntax)

Warn for accidental bracket and paren mixup for images and links.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

ok.md

In

[Mercury](https://example.com/mercury/) and
![Venus](https://example.com/venus.png).

Out

No messages.

not-ok.md

In

(Mercury)[https://example.com/mercury/] and
!(Venus)[https://example.com/venus.png].

Out

1:9-1:11: Unexpected `)[`, expected `[` and `]` around the text (label) and `(` and `)` around the URL for images and links, or an escape (`)\[`)
2:8-2:10: Unexpected `)[`, expected `[` and `]` around the text (label) and `(` and `)` around the URL for images and links, or an escape (`)\[`)

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-correct-media-syntax@1, 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