Narcissistic Pickle Meister
    Wondering what’s next for npm?Check out our public roadmap! »

    remark-lint-no-missing-blank-lines

    2.0.1 • Public • Published

    remark-lint-no-missing-blank-lines

    Build Coverage Downloads Size Sponsors Backers Chat

    Warn when missing blank lines before block content (and frontmatter content).

    This rule can be configured to allow tight list items without blank lines between their contents by passing {exceptTightLists: true} (default: false).

    Fix

    remark-stringify always uses one blank line between blocks if possible, or two lines when needed. The style of the list items persists.

    See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

    Presets

    This rule is not included in any default preset

    Example

    ok.md
    In
    Foo
     
    ## Bar
     
    - Paragraph
     
      + List.
     
    Paragraph.
    Out

    No messages.

    not-ok.md
    In
    Foo
    ## Bar
     
    - Paragraph
      + List.
     
    Paragraph.
    Out
    2:1-2:7: Missing blank line before block node
    5:3-5:10: Missing blank line before block node
    tight.md

    When configured with { exceptTightLists: true }.

    In
    Foo
    ## Bar
     
    - Paragraph
      + List.
     
    Paragraph.
    Out
    2:1-2:7: Missing blank line before block node

    Install

    npm:

    npm install remark-lint-no-missing-blank-lines

    Use

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

     …
     "remarkConfig": {
       "plugins": [
         …
         "lint",
    +    "lint-no-missing-blank-lines",
         …
       ]
     }
     …

    Or use it on the CLI directly

    remark -u lint -u lint-no-missing-blank-lines 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-missing-blank-lines'))
       .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

    Install

    npm i remark-lint-no-missing-blank-lines

    DownloadsWeekly Downloads

    2,950

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    7.43 kB

    Total Files

    3

    Last publish

    Collaborators

    • avatar
    • avatar