JSPM

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

2.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 37452
  • Score
    100M100P100Q182012F
  • License MIT

remark-lint rule to warn when full reference images are used if they can be collapsed

Package Exports

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

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-unneeded-full-reference-image) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

Build Coverage Downloads Size Sponsors Backers Chat

Warn when full reference images are used that could be collapsed.

Full references (such as [Remark][remark]) can also be written as a collapsed reference ([Remark][]) if normalising the reference text yields the label.

Presets

This rule is not included in any default preset

Example

ok.md
In
![alpha][]
![Bravo][]
![Charlie][delta]
Out

No messages.

not-ok.md
In
![alpha][alpha]
![Bravo][bravo]
![charlie][Charlie]
Out
1:1-1:16: Remove the image label as it matches the reference text
2:1-2:16: Remove the image label as it matches the reference text
3:1-3:20: Remove the image label as it matches the reference text

Install

npm:

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

Use

You probably want to use it on the CLI through a config file:

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

Or use it on the CLI directly

remark -u lint -u lint-no-unneeded-full-reference-image readme.md

Or use this on the API:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-unneeded-full-reference-image'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file))
   })

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