fix(review): Re:Viewで脚注がルールの対象に含まれているのをオプション化

checkFootnote(デフォルト: false)で脚注をチェックするかをオプション化した
脚注自体がtextlintの対象として曖昧なので、このオプションはun-documentなものとした

Author: azu

.babelrc

@@ -69,12 +69,12 @@ english only
     - 例外として許可したい文字列を設定する
     - `periodMark`に指定したものは自動的に許可リストに加わる
     - デフォルトは空 `[]`
-- `allowEmojiAtEnd`(bool):
+- `allowEmojiAtEnd`: `boolean`
     - 絵文字を末尾に置くことを許可するかどうか
-    - デフォルト: false
+    - デフォルト: `false`
 - `forceAppendPeriod`: `boolean`
     - 句点で終わって無い場合に`periodMark`を--fix時に追加するかどうか
-    - デフォルト: false
+    - デフォルト: `false`
 
 ```json
 {

README.md

@@ -22,24 +22,18 @@
     "test": "test"
   },
   "scripts": {
-    "test": "mocha test/",
-    "build": "NODE_ENV=production babel src --out-dir lib --source-maps",
-    "watch": "babel src --out-dir lib --watch --source-maps",
+    "test": "textlint-scripts test",
+    "build": "textlint-scripts build",
+    "watch": "textlint-scripts build --watch",
     "prepublish": "npm run --if-present build"
   },
   "keywords": [
     "textlint",
     "textlintrule"
   ],
   "devDependencies": {
-    "babel-cli": "^6.10.1",
-    "babel-preset-es2015": "^6.9.0",
-    "babel-preset-jsdoc-to-assert": "^2.0.1",
-    "babel-preset-power-assert": "^1.0.0",
-    "babel-register": "^6.9.0",
-    "mocha": "^2.5.3",
-    "power-assert": "^1.4.1",
-    "textlint-tester": "^2.0.0"
+    "textlint-plugin-review": "^0.3.3",
+    "textlint-scripts": "^2.1.0"
   },
   "dependencies": {
     "check-ends-with-period": "^1.0.1",

package.json

@@ -20,7 +20,12 @@ const defaultOptions = {
     allowEmojiAtEnd: false,
     // 句点で終わって無い場合に`periodMark`を--fix時に追加するかどうか
     // デフォルトでは自動的に追加しない
-    forceAppendPeriod: false
+    forceAppendPeriod: false,
+    // [Note] このオプションは標準外なので隠しオプション扱い
+    // [Warning] このオプションはsemverの範囲外なのでいつでも壊れる可能性がある
+    // 脚注はチェック対象から外すかどうか(実質Re:View向け)
+    // デフォルトでは脚注構文(Re:View)は無視する
+    checkFootnote: false
 };
 const reporter = (context, options = {}) => {
     const { Syntax, RuleError, report, fixer, getSource } = context;
@@ -30,17 +35,27 @@ const reporter = (context, options = {}) => {
     // 優先する句点記号は常に句点として許可される
     const allowPeriodMarks = (options.allowPeriodMarks || defaultOptions.allowPeriodMarks).concat(preferPeriodMark);
     const allowEmojiAtEnd = options.allowEmojiAtEnd !== undefined
-        ? options.allowEmojiAtEnd
-        : defaultOptions.allowEmojiAtEnd;
+                            ? options.allowEmojiAtEnd
+                            : defaultOptions.allowEmojiAtEnd;
     const forceAppendPeriod = options.forceAppendPeriod !== undefined
-        ? options.forceAppendPeriod
-        : defaultOptions.forceAppendPeriod;
-
+                              ? options.forceAppendPeriod
+                              : defaultOptions.forceAppendPeriod;
+    const checkFootnote = options.checkFootnote !== undefined
+                          ? options.checkFootnote
+                          : defaultOptions.checkFootnote;
+    // 脚注のNode Typeを定義(TxtASTの定義外)
+    const FootnoteNodes = [
+        // https://github.com/orangain/textlint-plugin-review
+        "Footnote",
+        // https://github.com/textlint/textlint/blob/master/packages/%40textlint/markdown-to-ast/src/mapping/markdown-syntax-map.js
+        // 実際にはmarkdown-to-astではこれはParagraphを含まないInlineNodeなのであまり意味はない
+        "Definition"
+    ];
     const ignoredNodeTypes = [
         Syntax.ListItem, Syntax.Link, Syntax.Code, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis
-    ];
+    ].concat(checkFootnote ? FootnoteNodes : []);
     return {
-        [Syntax.Paragraph](node){
+        [Syntax.Paragraph](node) {
             if (helper.isChildNode(node, ignoredNodeTypes)) {
                 return;
             }

src/textlint-rule-ja-no-mixed-period.js

@@ -1 +1 @@
---compilers js:babel-register
+--require textlint-scripts/register

test/mocha.opts

@@ -1,6 +1,33 @@
+import rule from "../src/textlint-rule-ja-no-mixed-period";
+
 const TextLintTester = require("textlint-tester");
+const reviewPlugin = require("textlint-plugin-review");
 const tester = new TextLintTester();
-import rule from "../src/textlint-rule-ja-no-mixed-period";
+tester.run("Re:view + textlint-rule-ja-no-mixed-period", {
+    plugins: [
+        {
+            pluginId: "review",
+            plugin: reviewPlugin
+        }
+    ],
+    rules: [
+        {
+            ruleId: "ja-no-mixed-period",
+            rule: rule,
+            options: {
+                checkFootnote: true
+            }
+        },
+    ]
+}, {
+    valid: [
+        {
+            text: `//footnote[test][脚注はデフォルトで無視される]`,
+            ext: ".re"
+        }
+    ]
+});
+
 tester.run("textlint-rule-ja-no-mixed-period", rule, {
     valid: [
         "これは問題ないです。",
@@ -39,7 +66,15 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
             options: {
                 allowPeriodMarks: [":"]
             },
+        },
+        // 脚注はMarkdownでは常に無視される
+        {
+            text: `テストです。[^1]
+            
+[^1]: 脚注はデフォルトで無視される`,
+            ext: ".md"
         }
+
     ],
     invalid: [
         // single match
@@ -140,6 +175,6 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
                     column: 11
                 }
             ]
-        },
+        }
     ]
 });