mdast-lint-alphabetize-lists

mdast-lint-alphabetize-lists

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

This rule ensures that all list items are in alphabetical order

<!-- Invalid -->

# Section
- B
- [A](#C)

<!-- Valid -->

# Section
- [A](#C)
- B

Using the rule

Via .mdastrc

npm install -g mdast
npm install -g mdast-lint
npm install mdast-lint-alphabetize-lists # local install!

Then, set up your .mdastrc:

{
  "plugins": {
    "mdast-lint": {
      "external": ["mdast-lint-alphabetize-lists"]
    }
  }
}

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-alphabetize-lists # global install!
mdast --no-stdout -u mdast-lint="external:[\"mdast-lint-alphabetize-lists\"]" 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).