feat: support allow file paths

azu · azu · commit 6ee856ffdb63 · 2017-12-01T11:16:44.000+09:00
diff --git a/README.md b/README.md
@@ -26,11 +26,33 @@ Via `.textlintrc`(Recommended)
 }
 ```
 
-## Options:
+## Options
 
 - `allow`: `string[]`
     - white list words or RegExp strings
+- `allowPaths`: `string[]`
+    - white list file paths that contains allow words array
+    - Support file format: JSON, yml, js
     
+For example, you can specify `{ allowPaths: ["./allow.json"] }`.
+
+`allow.json`:
+```
+[
+  "allow",
+  "/yes/i"
+]
+```    
+
+For example, you can specify `{ allowPaths: ["./allow.yml"] }`.
+
+`allow.yml`:
+```
+- "allow",
+- /yes/i
+```
+
+
 ### RegExp String
 
 textlint-filter-rule-whitelist allow to use RegExp like string.
diff --git a/package.json b/package.json
@@ -35,18 +35,19 @@
   "devDependencies": {
     "babel-cli": "^6.11.4",
     "babel-preset-es2015": "^6.9.0",
-    "babel-preset-jsdoc-to-assert": "^2.0.1",
+    "babel-preset-jsdoc-to-assert": "^4.0.0",
     "babel-preset-power-assert": "^1.0.0",
     "babel-register": "^6.11.6",
-    "mocha": "^2.5.3",
+    "mocha": "^4.0.1",
     "power-assert": "^1.4.1",
-    "textlint": "^7.1.0",
+    "textlint": "^9.1.1",
     "textlint-rule-report-node-types": "^1.1.0",
-    "textlint-tester": "^2.0.0"
+    "textlint-tester": "^3.0.3"
   },
   "dependencies": {
     "escape-string-regexp": "^1.0.5",
     "execall": "^1.0.0",
+    "rc-config-loader": "^2.0.1",
     "str-to-regexp": "^1.1.3"
   }
 }
diff --git a/src/textlint-filter-rule-whitelist.js b/src/textlint-filter-rule-whitelist.js
@@ -1,22 +1,55 @@
 // LICENSE : MIT
 "use strict";
+const path = require('path');
 const execall = require('execall');
 const escapeStringRegexp = require('escape-string-regexp');
 const toRegExp = require("str-to-regexp").toRegExp;
+const rcfile = require("rc-config-loader");
+
+const getAllowWordsFromFiles = (files, baseDirectory) => {
+    let results = [];
+    files.forEach(filePath => {
+        // TODO: use other loader
+        const contents = rcfile("file", {
+            // This is not json
+            configFileName: path.resolve(baseDirectory, filePath)
+        });
+        if (contents && Array.isArray(contents.config)) {
+            results = results.concat(contents.config);
+        } else {
+            throw new Error(`This allow file is not allow word list: ${filePath}`);
+        }
+    });
+    return results;
+};
+
 const COMPLEX_REGEX_END = /^.+\/(\w*)$/;
 const defaultOptions = {
-    // white list
-    // string or RegExp string
-    // e.g.
-    // "string"
-    // "/\\d+/"
-    // "/^===/m"
-    allow: []
+    /**
+     * white list strings or RegExp strings
+     * For example, you can specify following.
+     *
+     * [
+     *     "string",
+     *     "/\\d+/",
+     *     "/^===/m",
+     * ]
+     */
+    allow: [],
+    /**
+     * white list file paths
+     */
+    allowPaths: []
 };
 module.exports = function(context, options) {
     const { Syntax, shouldIgnore, getSource } = context;
+    const baseDirectory = context.getConfigBaseDir();
     const allowWords = options.allow || defaultOptions.allow;
-    const regExpWhiteList = allowWords.map(allowWord => {
+    const allowFileContents = options.allowPaths
+        ? getAllowWordsFromFiles(options.allowPaths, baseDirectory)
+        : [];
+    const allAllowWords = allowWords.concat(allowFileContents);
+    const regExpWhiteList = allAllowWords.map(allowWord => {
         if (!allowWord) {
             return /^$/;
         }
@@ -38,4 +71,4 @@ module.exports = function(context, options) {
             });
         }
     };
-};
+};
diff --git a/test/fixtures/allow.json b/test/fixtures/allow.json
@@ -0,0 +1,4 @@
+[
+  "allow",
+  "/yes/i"
+]
diff --git a/test/fixtures/allow.yml b/test/fixtures/allow.yml
@@ -0,0 +1,2 @@
+- "allow"
+- /yes/i
diff --git a/test/mocha.opts b/test/mocha.opts
@@ -1 +1 @@
---compilers js:babel-register
+--require babel-register
diff --git a/test/textlint-filter-rule-whitelist-test.js b/test/textlint-filter-rule-whitelist-test.js
@@ -1,12 +1,55 @@
 // LICENSE : MIT
 "use strict";
+const path = require("path");
 const TextLintCore = require("textlint").TextLintCore;
 const TextLintNodeType = require("textlint").TextLintNodeType;
 import filterRule from "../src/textlint-filter-rule-whitelist";
 import reportRule from "textlint-rule-report-node-types";
 
 const assert = require("power-assert");
 describe("textlint-rule-filter-whitelist", function() {
+    context("when allowPaths", function() {
+        it("should read json and use it as allow words", function() {
+            const textlint = new TextLintCore();
+            textlint.setupRules({
+                report: reportRule
+            }, {
+                report: {
+                    nodeTypes: [TextLintNodeType.Str]
+                }
+            });
+            textlint.setupFilterRules({
+                whitelist: filterRule
+            }, {
+                whitelist: {
+                    allowPaths: [path.join(__dirname, "fixtures/allow.json")]
+                }
+            });
+            return textlint.lintText("allow\n\nYES").then(({ messages }) => {
+                assert.equal(messages.length, 0);
+            });
+        });
+        it("should read yml and use it as allow words", function() {
+            const textlint = new TextLintCore();
+            textlint.setupRules({
+                report: reportRule
+            }, {
+                report: {
+                    nodeTypes: [TextLintNodeType.Str]
+                }
+            });
+            textlint.setupFilterRules({
+                whitelist: filterRule
+            }, {
+                whitelist: {
+                    allowPaths: [path.join(__dirname, "fixtures/allow.yml")]
+                }
+            });
+            return textlint.lintText("allow\n\nYES").then(({ messages }) => {
+                assert.equal(messages.length, 0);
+            });
+        })
+    });
     context("when report and filter type", function() {
         it("should messages is empty", function() {
             const textlint = new TextLintCore();
@@ -119,4 +162,4 @@ describe("textlint-rule-filter-whitelist", function() {
             });
         });
     });
-});
+});
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +[
 +  "allow",
 +  "/yes/i"
 +]
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`---compilers js:babel-register`
	`1`	`+--require babel-register`