Merge pull request #3 from azu/fix-1

fix(rule): don't modify ast, use filter function

Author: azu

.travis.yml

@@ -0,0 +1,3 @@
+sudo: false
+language: node_js
+node_js: "stable"

README.md

@@ -1,4 +1,4 @@
-# textlint-rule-rousseau
+# textlint-rule-rousseau [![Build Status](https://travis-ci.org/azu/textlint-rule-rousseau.svg?branch=master)](https://travis-ci.org/azu/textlint-rule-rousseau)
 
 A [textlint](https://github.com/textlint/textlint "textlint") rule check english sentence using [rousseau](https://github.com/GitbookIO/rousseau "rousseau").
 

package.json

@@ -40,12 +40,13 @@
     "babel-preset-es2015": "^6.5.0",
     "babel-register": "^6.5.2",
     "mocha": "^2.4.5",
-    "textlint": "^5.2.0",
-    "textlint-tester": "^0.4.1"
+    "textlint": "^6.0.1",
+    "textlint-tester": "^1.1.0"
   },
   "dependencies": {
     "rousseau": "github:azu/rousseau#fix-for-strict-mode",
     "textlint-rule-helper": "^1.1.5",
-    "textlint-util-to-string": "^1.2.0"
+    "textlint-util-to-string": "^1.2.0",
+    "unist-util-filter": "^0.2.1"
   }
 }

src/textlint-rule-rousseau.js

@@ -1,20 +1,23 @@
 // LICENSE : MIT
 "use strict";
-import {RuleHelper} from "textlint-rule-helper"
-import StringSource from "textlint-util-to-string";
-import rousseau from "rousseau";
+const {RuleHelper} = require("textlint-rule-helper");
+const StringSource = require("textlint-util-to-string").default;
+const rousseau = require("rousseau");
+const filter = require('unist-util-filter');
 const defaultOptions = {
     // "suggestion", "warning", "error"
     showLevels: ["suggestion", "warning", "error"],
+    // ignore check type of https://github.com/GitbookIO/rousseau#checks
     ignoreTypes: [],
-    fakeInlineCode: true
+    // ignore textlint's node type
+    ignoreInlineNodeTypes: undefined
 };
 export default function textlintRousseau(context, options = defaultOptions) {
     const helper = new RuleHelper(context);
     const {Syntax, RuleError, report, getSource} = context;
     const showLevels = options.showLevels || defaultOptions.showLevels;
     const ignoreTypes = options.ignoreTypes || defaultOptions.ignoreTypes;
-    const fakeInlineCode = options.fakeInlineCode || defaultOptions.fakeInlineCode;
+    const ignoreInlineNodeTypes = options.ignoreInlineNodeTypes || [Syntax.Image, Syntax.Code, Syntax.Link];
     const isShowType = (type)=> {
         return ignoreTypes.indexOf(type) === -1;
     };
@@ -74,29 +77,23 @@ export default function textlintRousseau(context, options = defaultOptions) {
         });
         report(node, ruleError);
     };
+
     return {
         [Syntax.Paragraph](node){
             if (helper.isChildNode(node, [Syntax.Link, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis])) {
                 return;
             }
-            // fake `code`
-            if (fakeInlineCode) {
-                node.children = node.children.map(childNode => {
-                    if (childNode.type === Syntax.Code) {
-                        return {
-                            type: Syntax.Str,
-                            value: "code",
-                            raw: "code",
-                            loc: childNode.loc,
-                            range: childNode.range
-                        }
-                    }
-                    return childNode;
-                });
+            const filteredNode = filter(node, (node) => {
+                return ignoreInlineNodeTypes.indexOf(node.type) === -1;
+            });
+            if (!filteredNode) {
+                return;
             }
-            const source = new StringSource(node);
+            const source = new StringSource(filteredNode);
             const text = source.toString();
-            const reportSourceError = reportError.bind(null, node, source);
+            const reportSourceError = (results) => {
+                reportError(node, source, results);
+            };
             rousseau(text, function (err, results) {
                 if (err) {
                     throw err;

test/textlint-rule-rousseau-test.js

@@ -7,6 +7,12 @@ import rule from "../src/textlint-rule-rousseau";
 // ruleName, rule, { valid, invalid }
 tester.run("rousseau", rule, {
     valid: [
+        // ignore Link
+        "[So the cat was stolen.](http://example.com)",
+        // ignore Image
+        "![So the cat was stolen.](http://example.com)",
+        // ignore Code
+        "`So the cat was stolen.`",
         "This is pen.",
         {
             text: "this is pen.",