docs: Update README

Author: azu

README.md

@@ -22,18 +22,22 @@ Via `.textlintrc`.
 
 ### Options
 
-Defaults: **Not** allow to use `!?！？`.
+Defaults: Disallows to use `!?！？`.
 
-- `allow`: ["Yahoo!"],
-    - allow words
-- `allowHalfWidthExclamation`: false,
+- `allow`: `string[]`,
+    - allow word list that suppor [RegExp-like String](https://github.com/textlint/textlint-filter-rule-allowlist#regexp-like-string)
+- `allowHalfWidthExclamation`: `boolean`
     - allow to use !
-- `allowFullWidthExclamation`: false,
+    - Default: `false`
+- `allowFullWidthExclamation`: `boolean`
     - allow to use ！
-- `allowHalfWidthQuestion`: false,
+    - Default: `false`
+- `allowHalfWidthQuestion`: `boolean`
     - allow to use ?
-- `allowFullWidthQuestion`: false
+    - Default: `false`
+- `allowFullWidthQuestion`: `boolean`
     - allow to use ？
+    - Default: `false`
 
 ```
 {

package.json

@@ -25,14 +25,34 @@
     "test": "textlint-scripts test",
     "build": "textlint-scripts build",
     "watch": "textlint-scripts build --watch",
-    "prepublish": "npm run --if-present build"
+    "prepublish": "npm run --if-present build",
+    "prettier": "prettier --write \"**/*.{js,jsx,ts,tsx,css}\""
   },
   "devDependencies": {
+    "husky": "^4.3.0",
+    "lint-staged": "^10.3.0",
+    "prettier": "^2.1.1",
     "textlint-scripts": "^3.0.0"
   },
   "dependencies": {
     "@textlint/regexp-string-matcher": "^1.1.0",
     "match-index": "^1.0.3",
     "textlint-rule-helper": "^2.1.1"
+  },
+  "prettier": {
+    "singleQuote": false,
+    "printWidth": 120,
+    "tabWidth": 4,
+    "trailingComma": "none"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,css}": [
+      "prettier --write"
+    ]
   }
 }

src/textlint-rule-no-exclamation-question-mark.js

@@ -1,8 +1,8 @@
 // LICENSE : MIT
 "use strict";
-import {RuleHelper} from "textlint-rule-helper";
-import {matchPatterns} from "@textlint/regexp-string-matcher";
-import {matchCaptureGroupAll} from "match-index"
+import { RuleHelper } from "textlint-rule-helper";
+import { matchPatterns } from "@textlint/regexp-string-matcher";
+import { matchCaptureGroupAll } from "match-index";
 
 /**
  * if actual is in the `matchPatternResults`, return true
@@ -11,24 +11,23 @@ import {matchCaptureGroupAll} from "match-index"
  * @returns {boolean}
  */
 const isIgnoredRange = (matchPatternResults, actual) => {
-    return matchPatternResults.some(result => {
+    return matchPatternResults.some((result) => {
         return result.startIndex <= actual.index && actual.index <= result.endIndex;
     });
 };
 
+const DEFAULT_ALLOW_LIST = ["Yahoo!"];
 const defaultOptions = {
     // allow words
-    "allow": [
-        "Yahoo!"
-    ],
+    allow: [],
     // allow to use !
-    "allowHalfWidthExclamation": false,
+    allowHalfWidthExclamation: false,
     // allow to use ！
-    "allowFullWidthExclamation": false,
+    allowFullWidthExclamation: false,
     // allow to use ?
-    "allowHalfWidthQuestion": false,
+    allowHalfWidthQuestion: false,
     // allow to use ？
-    "allowFullWidthQuestion": false
+    allowFullWidthQuestion: false
 };
 const Mark = {
     HalfWidthExclamation: /(!)/,
@@ -38,16 +37,16 @@ const Mark = {
 };
 
 module.exports = function (context, options = defaultOptions) {
-    const {Syntax, RuleError, report, getSource} = context;
+    const { Syntax, RuleError, report, getSource } = context;
     const helper = new RuleHelper(context);
-    const allow = options.allow || defaultOptions.allow;
+    const allow = (options.allow || defaultOptions.allow).concat(DEFAULT_ALLOW_LIST);
     const allowHalfWidthExclamation = options.allowHalfWidthExclamation || defaultOptions.allowHalfWidthExclamation;
     const allowFullWidthExclamation = options.allowFullWidthExclamation || defaultOptions.allowFullWidthExclamation;
     const allowHalfWidthQuestion = options.allowHalfWidthQuestion || defaultOptions.allowHalfWidthQuestion;
     const allowFullWidthQuestion = options.allowFullWidthQuestion || defaultOptions.allowFullWidthQuestion;
 
     return {
-        [Syntax.Str](node){
+        [Syntax.Str](node) {
             if (helper.isChildNode(node, [Syntax.Link, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis])) {
                 return;
             }
@@ -60,16 +59,19 @@ module.exports = function (context, options = defaultOptions) {
             const reportIfIncludeMark = (text, markRegExp) => {
                 const ignoreMatch = matchPatterns(text, allow);
                 matchCaptureGroupAll(text, markRegExp).forEach((actual) => {
-                    const {text, index} = actual;
+                    const { text, index } = actual;
 
                     // 無視する単語を含んでいるなら無視
                     if (isIgnoredRange(ignoreMatch, actual)) {
                         return;
                     }
 
-                    report(node, new RuleError(`Disallow to use "${text}".`, {
-                        index
-                    }));
+                    report(
+                        node,
+                        new RuleError(`Disallow to use "${text}".`, {
+                            index
+                        })
+                    );
                 });
             };
             // Check
@@ -86,5 +88,5 @@ module.exports = function (context, options = defaultOptions) {
                 reportIfIncludeMark(text, Mark.FullWidthQuestion);
             }
         }
-    }
-};
+    };
+};

test/textlint-rule-no-exclamation-question-mark-test.js

@@ -89,4 +89,4 @@ tester.run("no-exclamation-question-mark", rule, {
             ]
         }
     ]
-});
+});