Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

remark-lint-no-shortcut-reference-link

Package Overview
Dependencies
Maintainers
2
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

remark-lint-no-shortcut-reference-link

remark-lint rule to warn when shortcut reference links are used

  • 1.0.5
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
152K
increased by21.57%
Maintainers
2
Weekly downloads
 
Created
Source

Build Coverage Downloads Size Sponsors Backers Chat

Warn when shortcut reference links are used.

Shortcut references render as links when a definition is found, and as plain text without definition. Sometimes, you don’t intend to create a link from the reference, but this rule still warns anyway. In that case, you can escape the reference like so: \[foo].

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-markdown-style-guide
remark-preset-lint-recommended

Example

ok.md
In
[foo][]

[foo]: http://foo.bar/baz
Out

No messages.

not-ok.md
In
[foo]

[foo]: http://foo.bar/baz
Out
1:1-1:6: Use the trailing `[]` on reference links

Install

npm:

npm install remark-lint-no-shortcut-reference-link

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-shortcut-reference-link",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-shortcut-reference-link 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-shortcut-reference-link'))
   .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

Keywords

FAQs

Package last updated on 24 Mar 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc