https://github.com/textlint-rule/textlint-rule-period-in-list-item
textlint rule that check with or without period in list item.
https://github.com/textlint-rule/textlint-rule-period-in-list-item
linting markdown natural-language textlint
Last synced: 2 months ago
JSON representation
textlint rule that check with or without period in list item.
- Host: GitHub
- URL: https://github.com/textlint-rule/textlint-rule-period-in-list-item
- Owner: textlint-rule
- License: mit
- Created: 2017-03-22T00:49:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-15T02:28:59.000Z (over 2 years ago)
- Last Synced: 2025-04-23T01:16:33.648Z (2 months ago)
- Topics: linting, markdown, natural-language, textlint
- Language: JavaScript
- Size: 372 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# textlint-rule-period-in-list-item
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](https://www.npmjs.com/):
npm install textlint-rule-period-in-list-item
## Usage
Via `.textlintrc`(Recommended)
```json
{
"rules": {
"period-in-list-item": true
}
}
```
Via CLI
```
textlint --rule period-in-list-item README.md
```
## Options
```json5
{
// 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,
// define 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,
// Allow ordered list item
// 1. ~.
// 2. ~.
"allowOrderedList": 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.
```json
{
"rules": {
"period-in-list-item": {
"periodMark": ".",
"forceAppendPeriod": true
}
}
}
```
**Before**
```
- item
```
**After**
`textlint --fix` fixes this issue.
```
- item.
```
## Related
- [textlint-ja/textlint-rule-ja-no-mixed-period: 文末の句点(。)の統一 と 抜けをチェックするtextlintルール](https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period/ "textlint-ja/textlint-rule-ja-no-mixed-period: 文末の句点(。)の統一 と 抜けをチェックするtextlintルール")
## Changelog
See [Releases page](https://github.com/textlint-rule/textlint-rule-period-in-list-item/releases).
## 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](https://github.com/textlint-rule/textlint-rule-period-in-list-item/issues).
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
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu