Markdown List Linter

Command line interface (CLI) tool to lint markdown lists and warn when list items are not alphabetically ordered.

A complete solution

This functionality is available to be consumed in three different ways:

• ⚡ A GitHub Action as part of your CI/CD process

• 📦 An NPM package that can be consumed in your JavaScript or TypeScript code

• 💻 A CLI that you can run in your terminal

Installation

You can install this CLI tool globally.

npm install markdown-list-linter-cli -g

Usage

Very simple to use all results will be printed in the terminal.

> markdown-list-linter -f ./data/valid_file.md

When there are no errors the returned object should look something like this.

SUMMARY:
No errors found

If you supply a markdown file which has a list that needs to be sorted.

> markdown-list-linter -f ./data/invalid_file.md

When there are errors the returned object should look something like this.

SUMMARY:
Markdown list needs to be sorted

DETAILS:
Please correct the alphabetical order for these heading items
    Section #1
        D
        A
        B
        C

Please correct the alphabetical order for these list items
    Section #1
        African Buffalo
        Aardwolf

    Section #2
        Chameleon
        Camel
        Cheetah
        Canary

The items in each section are the items in the list which need to be reordered.

For help command, type the following.

> markdown-list-linter -h