remark-lint-no-unneeded-full-reference-image

!Buildbadge-build-imagebadge-build-url !Coveragebadge-coverage-imagebadge-coverage-url !Downloadsbadge-downloads-imagebadge-downloads-url !Sizebadge-size-imagebadge-size-url !Sponsorsbadge-funding-sponsors-imagebadge-funding-url !Backersbadge-funding-backers-imagebadge-funding-url !Chatbadge-chat-imagebadge-chat-url
remark-lintgithub-remark-lint rule to warn when unneeded full reference images are used.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API

unified().use(remarkLintNoUnneededFullReferenceImage)

• Recommendation
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks for unneeded full reference images.

When should I use this?

You can use this package to check that reference images are consistent.

Presets

This plugin is not included in presets maintained here.

Install

This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:

npm install remark-lint-no-unneeded-full-reference-image

In Deno with esm.shesm-sh:

import remarkLintNoUnneededFullReferenceImage from 'https://esm.sh/remark-lint-no-unneeded-full-reference-image@4'

In browsers with esm.shesm-sh:

<script type="module">
  import remarkLintNoUnneededFullReferenceImage from 'https://esm.sh/remark-lint-no-unneeded-full-reference-image@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoUnneededFullReferenceImage from 'remark-lint-no-unneeded-full-reference-image'
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(remarkLintNoUnneededFullReferenceImage)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-unneeded-full-reference-image .

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

…
"remarkConfig": {
  "plugins": [
    …
    "remark-lint",
+    "remark-lint-no-unneeded-full-reference-image",
    …
  ]
}
…

API

This package exports no identifiers. It exports no additional TypeScripttypescript types. The default export is remarkLintNoUnneededFullReferenceImageapi-remark-lint-no-unneeded-full-reference-image.

unified().use(remarkLintNoUnneededFullReferenceImage)

Warn when unneeded full reference images are used.

Parameters

There are no options.

Returns

Transform (Transformer from unifiedgithub-unified-transformer).

Recommendation

Full reference syntax (![Alt][alt]) is quite verbose compared to the concise collapsed reference syntax (![Alt][]).

Examples

ok.md

In

![Mercury][] and ![Venus][venus-image].

Out

No messages.

not-ok.md

In

![Mercury][mercury].

Out

1:1-1:20: Unexpected full reference image (`![text][label]`) where the identifier can be inferred from the text, expected collapsed reference (`![text][]`)

escape.md

In

👉 Note: this example uses GFM (remark-gfmgithub-remark-gfm).

Matrix:

| Kind                      | Text normal | Text escape  | Text character reference |
| ------------------------- | ----------- | ------------ | ------------------------ |
| Label normal              | ![&][&]     | ![\&][&]     | ![&][&]              |
| Label escape              | ![&][\&]    | ![\&][\&]    | ![&][\&]             |
| Label character reference | ![&][&] | ![\&][&] | ![&][&]          |

When using the above matrix, the first row will go to `/a.png`, the second
to `b`, third to `c`.
Removing all labels, you’d instead get it per column: `/a.png`, `b`, `c`.
That shows the label is not needed when it matches the text, and is otherwise.

Out

5:31-5:38: Unexpected full reference image (`![text][label]`) where the identifier can be inferred from the text, expected collapsed reference (`![text][]`)
6:45-6:54: Unexpected full reference image (`![text][label]`) where the identifier can be inferred from the text, expected collapsed reference (`![text][]`)
7:60-7:75: Unexpected full reference image (`![text][label]`) where the identifier can be inferred from the text, expected collapsed reference (`![text][]`)

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-unneeded-full-reference-image@4, compatible with Node.js 16.

Contribute

See contributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways to get started. See support.mdgithub-dotfiles-support for ways to get help.
This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITfile-license © Titus Wormerauthor