This is helper library for creating textlint rule.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
test fix(wrap): fix arguments order Jan 3, 2019
.travis.yml test(travis): add Travis CI Oct 5, 2018

textlint-rule-helper Build Status

This is helper library for creating textlint rule.


npm install textlint-rule-helper


class RuleHelper

Helper for traversing TxtAST.

ruleHelper.getParents(node) : TxtNode[]

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.


  • node TxtNode - the node is start point.

ruleHelper.isChildNode(node, types): boolean

Return true if node is wrapped any one of node types.


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

class IgnoreNodeManager

You can manager ignoring range in texts.

ignore(node): void

Add the range of node to ignoring range list.


  • node TxtNode - target node

ignoreRange(range): void

Add the range to ignoring range list


  • range [number, number]

ignoreChildrenByTypes(targetNode, ignoredNodeTypes): void

if the children node has the type that is included in ignoredNodeTypes, Add range of children node of node to ignoring range list,


  • targetNode TxtNode - target node
  • ignoredNodeTypes Array.<string> - are node types for ignoring

isIgnoredIndex(index): boolean

If the index is included in ignoring range list, return true. index should be absolute position.


  • index number - index value start with 0

isIgnoredRange(range): boolean

If the range is included in ignoring range list, return true. range should includes absolute positions.


  • range [number, number]

isIgnored(node): boolean

If the range of node is included in ignoring range list, return true.


  • node TxtNode - target node

RuleHelper and IgnoreNodeManager Example

A rule for textlint.

import { RuleHelper } from "textlint-rule-helper";
import { IgnoreNodeManager } from "textlint-rule-helper";
module.exports = function(context) {
  var helper = new RuleHelper(context);
  var ignoreNodeManager = new IgnoreNodeManager();
  var exports = {};
  var reportingErrors = [];
  exports[context.Syntax.Paragraph] = function(node) {
    // Add `Code` node to ignoring list
    ignoreNodeManager.ignoreChildrenByTypes(node, [context.Syntax.Code]);
    // do something
    reportingErrors.push(node, ruleError);
  exports[context.Syntax.Str] = function(node) {
    // parent nodes is any one Link or Image.
    if (helper.isChildNode(node, [context.Syntax.Link, context.Syntax.Image])) {
    // get Parents
    var parents = helper.getParents(node);
  exports[Syntax.Document + ":exit"] = function(node) {
    reportingErrors.forEach(function(node, ruleError) {
      // if the error is ignored, don't report
      if (ignoreNodeManager.isIgnored(node)) {
      // report actual
  return exports;

wrapReportHandler(context, options, handler): TextlintRuleReportHandler


  • context TextlintRuleContent - rule context object
  • options {{ignoreNodeTypes: TxtNodeType[]}} - options
  • handler (report: (node: AnyTxtNode, ruleError: TextlintRuleError) => void) => any - handler should return a object

wrapReportHandler is high level API that use RuleHelper and IgnoreNodeManager. It aim to easy to ignore some Node type for preventing unnecessary error report.

Example: ignore BlockQuote and Code node.

import { wrapReportHandler } from "textlint-rule-helper";
const reporter = function (context) {
   const { Syntax, getSource } = context;
   return wrapReportHandler(context, {
       ignoreNodeTypes: [Syntax.BlockQuote, Syntax.Code]
   },report => { // <= wrap version of
       // handler should return a rule handler object
       return {
           [Syntax.Paragraph](node) {
               const text = getSource(node);
               const index ="code");
                * Following text is matched, but it will not reported.
                * ----
                * This is `code`.
                * > code
                * ----
                if(index === -1){
                report(node, new context.RuleError(, {
module.exports = reporter;

The Mechanism of wrapReportHandler: `

  • Ignore all parent nodes that are matched with ignoreNodeTypes.
  • Ignore all children nodes that are matched with ignoreNodeTypes.
    • wrapReportHandler create custom report function that ignore matched node


You can see real use-case of this helper library.



# watch
npm run watch
# build
npm run build
# test
npm run test


  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