textlint rule that check with or without period in list item.
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src fix(rule): add "ignoreLinkEnd" options Mar 22, 2017
test test(rule): add test case Apr 11, 2017
.gitignore initial commit Mar 22, 2017
.travis.yml initial commit Mar 22, 2017
LICENSE initial commit Mar 22, 2017
README.md Update README.md Apr 10, 2017
package.json 0.2.0 Mar 22, 2017

README.md

textlint-rule-period-in-list-item Build Status textlint rule

textlint rule that check with or without period in list item.

Default

No period mark at end of the list item. You can change the behavior by options.

OK:

- item

NG:

- item.

Install

Install with npm:

npm install textlint-rule-period-in-list-item

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "period-in-list-item": true
    }
}

Via CLI

textlint --rule period-in-list-item README.md

Options

{
    // prefer to use period mark.
    // "" (default is no period)
    // You can select period mark like "." from "periodMarks".
    "periodMark": "",
    // Built-in recognized period mark list
    // if the period of the text is not `periodMark` and it is a string in the `periodMarks`,
    "periodMarks": [".", "", ""],
    // Ignore only link tag
    // - [text](link)
    // It is not needed period mark
    "ignoreLinkEnd": true,
    // allow exception period mark list at end of the list item
    // Ignore this period mark
    "allowPeriodMarks": [],
    // Allow emoji at end of the list item
    "allowEmoji": false,
    // If not exist `periodMark` at end of the list item
    // Automatically, append `periodMark` when does textlint --fix
    "forceAppendPeriod": false
}

Example

Use . as period mark at end of the list item. Automatically, force append periodMark.

{
    "rules": {
        "period-in-list-item": {
           "periodMark": ".",
           "forceAppendPeriod": true
        }
    }
}

Before

- item

<!-- Not exist period mark(".") at end of list item. -->

After

textlint --fix fixes this issue.

- item.

Related

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu