JSPM

remark-lint-mdash-style

1.1.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 63
  • Score
    100M100P100Q73986F
  • License MIT

rule for remark-lint to handle mdash style

Package Exports

  • remark-lint-mdash-style

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-mdash-style) 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-mdash-style npm version npm bundle size

Warn when the mdash style violate a given style.

Options: '―', '-', '--', default: '―'.

Presets

This rule is not included in any default preset

Example

valid.md
In
`remark-lint` ― powerful Markdown processor powered by plugins.
Out

No messages.

invalid.md
In
`remark-lint` - powerful Markdown processor powered by plugins.

`remark-lint` -- powerful Markdown processor powered by plugins.
Out
1:1-1:64: Use `―` instead of `-` for mdash
3:1-3:65: Use `―` instead of `--` for mdash
valid.md

When configured with '-'.

In
`remark-lint` - powerful Markdown processor powered by plugins.
Out

No messages.

valid.md

When configured with '--'.

In
`remark-lint` -- powerful Markdown processor powered by plugins.
Out

No messages.

Install

[npm][]:

npm install remark-lint-mdash-style

Use

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

 ...
 "remarkConfig": {
   "plugins": [
     ...
     "lint",
+    "lint-mdash-style",
     ...
   ]
 }
 ...

Or use it on the CLI directly

remark -u lint -u lint-mdash-style 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-mdash-style'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });