remark-lint-list-item-style
Ƭ Options: Object
Options type for the remark-lint-list-item-style plugin.
| Name | Type | Description |
|---|---|---|
checkFirstWord? |
typeof optionsCheckFirstWord[number] |
Checks that the first word of each stringified list item paragraph begins with a non-lowercase character ("capitalize") or a non-uppercase character ("lowercase"). List items beginning with a link, image, or inline code block are ignored. Default ts "capitalize" |
checkListSpread? |
typeof optionsCheckListSpread[number] |
Determines how checkPunctuation is applied to list items with spread children. Has no effect when checkPunctuation is false. Default ts "each" |
checkPunctuation? |
false | (string | RegExp)[] |
Checks that the final character of each stringified list item matches at least one of the given values. To match all unicode punctuation characters, you could provide ["\p{P}"] instead of the default, but this will match characters like ) and ]. Alternatively, to prevent punctuation, you could provide ["\P{P}"]. Lines that consist solely of an image are ignored. Default ts ["(\\.|\\?|;|,|!)"] |
ignoredFirstWords? |
(string | RegExp)[] |
Words that would normally be checked with respect to the checkFirstWord option will be ignored if they match at least one of the given values. Use this option to prevent false positives (e.g. "iOS", "eBay"). Default ts [] |
packages/remark-lint-list-item-style/src/index.ts:30
• Const optionsCheckFirstWord: readonly [false, "capitalize", "lowercase"]
Valid values for the Options.checkFirstWord property.
packages/remark-lint-list-item-style/src/index.ts:15
• Const optionsCheckListSpread: readonly ["first", "final", "first-and-final", "each"]
Valid values for the Options.checkListSpread property.
packages/remark-lint-list-item-style/src/index.ts:20
▸ default(this, ...parameters): undefined | void | Transformer<Node, Node>
A remark-lint rule that takes a Root node as input and attaches any error messages to the resulting virtual file pertaining to list item style.
| Name | Type |
|---|---|
this |
Processor<undefined, undefined, undefined, undefined, undefined> |
...parameters |
[Options] | [] |
undefined | void | Transformer<Node, Node>
node_modules/unified/lib/index.d.ts:946