Proposal: Add options to customize filter AST type

[Leko]

Currently, filtered AST types are Link, Image, BlockQuote, Emphasis. https://github.com/textlint-rule/textlint-rule-prh/blob/dd4bb87109a10ed428eee8baee76925b6396c032/src/textlint-rule-prh.js#L136

I want to add Header to the blacklist. But it cannot set as default behavior. It's not needed in many use cases. So I propose to support ignoreSyntax option.

• Type: Array<String> (optional)
• Default values: [Syntax.Link, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis]

How about it?

[azu]

Thanks for report.

tl;dr: ignoreSyntax name is large in scope for the behavior.

This option is reasonable. But, we need to get more meaningful naming instead of ignoreSyntax. Because, following option mismatch the behavior.

{
  "prh": {
    "ignoreSyntax": []
  }
}

It seems that prh check all syntax that includes Code. But, the expectation mismatch real behavior. Actually, texltint-rule-prh does not check Code. (I want to check Code node by option in the future.)

Note: use NodeType instead of Syntax.

[Leko]

@azu Then, what about checkHeader option?

Naming rule: {prefix}{NodeType}

• checkLink: boolean, default: false
• checkImage: boolean, default: false
• checkBlockQuote: boolean, default: false
• checkEmphasis: boolean, default: false
• checkHeader: boolean, default: true

Other possibilities of prefix:

• lint (ex. lintHeader)
• visit (ex. visitHeader)
• skip (ex. skipHeader)

[azu]

I like visitHeader, but it is non-intuitive naming. I think that checkHeader is passable.

[Leko]

I think so. visit brings to mind internal behavior. Gotcha. I'll submit a pull request named as check*. Thanks.