Nybble Processing Mainframe

    remark-lint-mdash-style

    1.1.1 • Public • Published

    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));
       });

    Install

    npm i remark-lint-mdash-style

    DownloadsWeekly Downloads

    186

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    4.79 kB

    Total Files

    3

    Last publish

    Collaborators

    • alexandrtovmach