Skip to content

v2.2.0

Compare
Choose a tag to compare
@azu azu released this 16 May 06:27
· 21 commits to master since this release

Features

  • helper: add isPlainStrNode(node): boolean #17 #16

isPlainStrNode() return true if the node is Str node and fill following conditions:

  • the node is Str node
  • the node is under the Paragraph node
  • the node is not under the BlockQuote

This function is useful for the common use case.
If you want to lint Str node, but you do not want to lint styled node, this function is useful.
The styled node is Link, Strong, BlockQuote, Header, and it may be written by other people.
For example, you have added a link to your document, the link's title is written by other people.

Opposite of it, The plain Str node is just under the Paragraph node, and it was written by you.

Examples

Return true

str str str
- list text

Return false

# Header
![alt text](https://example.com)
[link title](https://example.com)
> BlockQuote text
**Strong text**
[linkReference][]
[^footnote text]

For more details, see https://github.com/textlint/textlint-rule-helper#rulehelperisplainstrnodenode-boolean