Noiseless Praying Mantis

    mdast-lint-empty-sections

    0.1.1 • Public • Published

    mdast-lint-empty-sections

    This mdast-lint rule was created for free-programming-books-lint to enforce free-programming-books formatting guidelines.

    This rule checks that every ([#]+)title has some content. This content can be anything: a lower-level title, a higher-level title, text, list, etc. It will only complain if you have a n-level title without content followed by another n-level title.

    <!-- Invalid -->
     
    # A
     
    ## B (this section is empty!)
     
    ## C
     
    <!-- Valid -->
     
    # A
     
    ## C

    Using the rule

    Via .mdastrc

    npm install -g mdast
    npm install -g mdast-lint
    npm install mdast-lint-empty-sections # local install! 

    Then, set up your .mdastrc:

    {
      "plugins": {
        "mdast-lint": {
          "external": ["mdast-lint-empty-sections"]
        }
      }
    }

    Now you can use the following command to run the lint:

    mdast --no-stdout xxx.md

    Via CLI

    npm install -g mdast
    npm install -g mdast-lint
    npm install -g mdast-lint-empty-sections # global install! 
    mdast --no-stdout -u mdast-lint="external:[\"mdast-lint-empty-sections\"]" xxx.md

    Note that the lint=<lint_options> option only works with mdast >= 1.1.1.

    This README.md is based on this one by @chcokr (MIT).

    Keywords

    none

    Install

    npm i mdast-lint-empty-sections

    DownloadsWeekly Downloads

    4

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • vhf