Remark-lint-ending-period NPM

remark-lint-ending-period

This rule ensures that all list items are ended with certain symbol. The default symbol is ..

<!-- Invalid -->

# Section
- A
- B

<!-- Valid -->

# Section
- A.
- B.

Using the rule

Via `.remarkrc`

npm install -g remark
npm install -g remark-lint
npm install remark-lint-ending-period # local install!

Then, set up your .remarkrc:

{
  "plugins": {
    "remark-lint": {
      "external": ["remark-lint-ending-period"]
    }
  }
}

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

remark --no-stdout xxx.md

Using another ending symbol

Set up your .remarkrc:

{
  "plugins": {
    "remark-lint": {
      "external": ["remark-lint-ending-period"],
      "ending-period": {
        "endings": ["...", ";", "."]
        }
    }
  }
}

Via CLI

npm install -g remark
npm install -g remark-lint
npm install -g remark-lint-ending-period # global install!
remark --no-stdout -u remark-lint="external:[\"remark-lint-ending-period\"]" xxx.md

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