textlint-rule-helper

textlint-rule-helper

This is helper library for creating textlint rule.

Installation

npm install textlint-rule-helper

Usage - API

####class: RuleHelper Members

• class: RuleHelper
  • new RuleHelper()
  • ruleHelper.getParents(node)
  • ruleHelper.isChildNode(node, types)

#####new RuleHelper() RuleHelper is helper class for textlint.

#####ruleHelper.getParents(node) Get parents of node. The parent nodes are returned in order from the closest parent to the outer ones. node is not contained in the results.

Params

• node TxtNode - the node is start point.

Returns: Array.<TxtNode>
#####ruleHelper.isChildNode(node, types) Return true if node is wrapped any one of node types.

Params

• node TxtNode - is target node
• types Array.<string> - are wrapped target node

Returns: boolean

####ruleHelper.getParents(node) Get parents of node. The parent nodes are returned in order from the closest parent to the outer ones. node is not contained in the results.

Params

• node TxtNode - the node is start point.

Returns: Array.<TxtNode>

####ruleHelper.isChildNode(node, types) Return true if node is wrapped any one of node types.

Params

• node TxtNode - is target node
• types Array.<string> - are wrapped target node

Returns: boolean

Example

A rule for textlint.

var RuleHelper = require("textlint-rule-helper").RuleHelper;
module.exports = function (context) {
    var helper = new RuleHelper(context);
    var exports = {}
    exports[context.Syntax.Str] = function(node){
        // parent nodes is any one Link or Image.
        if(helper.isChildNode(node, [context.Syntax.Link, context.Syntax.Image]){
            return;
        }
        // get Parents
        var parents = helper.getParents(node);
        
    }
    return exports;
}

Development

# watch
npm run watch
# build
npm run build
# test
npm run test
# Generate README from tempalte
npm run docs

Contributing

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

License

MIT