textlint rule that check capitalization in english text.
OK:
In text, follow the standard capitalization rules for American English. Additionally:
First, sentence should be capital. Second, sentence should be capital.
# Capitalization in titles and headings
## Capitalization and colons
Use a lowercase letter to begin the first word of the text immediately following a colon, unless the text is one of the following:
- A proper noun.
- A quotation.
- An item in a bulleted, numbered, or definition list.
- Text that follows a label, such as a Caution or Note.
- A subheading on the same line as a heading.
NG:
in text, follow the standard capitalization rules for American English
first, sentence should be capital. second, sentence should be capital.
# capitalization in titles and headings
- a proper noun.
- a quotation.
- an item in a bulleted, numbered, or definition list.
- text that follows a label, such as a Caution or Note.
- a subheading on the same line as a heading.
 is not capital.Install with npm:
npm install textlint-rule-en-capitalization
Via .textlintrc(Recommended)
{
"rules": {
"en-capitalization": true
}
}Via CLI
textlint --rule en-capitalization README.md
You can disable check by options.
{
"rules": {
"en-capitalization": {
// allow lower-case words in Header
"allowHeading": true,
// allow lower-case words in Image alt
"allowFigures": true,
// allow lower-case words in ListItem
"allowLists": true,
// allow lower-case words in anywhere
"allowWords": []
}
}
}- Capitalization | Google Developer Documentation Style Guide | Google Developers
- Purdue OWL: Capital Letters
See Releases page.
Install devDependencies and Run npm test:
npm i -d && npm test
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
MIT © azu