docs: Update README

textlint-rule · Sep 14, 2020 · 3ab59c5 · 3ab59c5
1 parent 6e01ed2
commit 3ab59c5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,8 @@ Defaults: Disallows to use `!?！？`.
 
 - `allow`: `string[]`,
     - allow word list that suppor [RegExp-like String](https://github.com/textlint/textlint-filter-rule-allowlist#regexp-like-string)
+    - some unique noun is allowed by default
+    - Default: `[]`
 - `allowHalfWidthExclamation`: `boolean`
     - allow to use !
     - Default: `false`

diff --git a/src/textlint-rule-no-exclamation-question-mark.js b/src/textlint-rule-no-exclamation-question-mark.js
@@ -16,7 +16,7 @@ const isIgnoredRange = (matchPatternResults, actual) => {
     });
 };
 
-const DEFAULT_ALLOW_LIST = ["Yahoo!"];
+const BUILTIN_ALLOW_LIST = ["Yahoo!"];
 const defaultOptions = {
     // allow words
     allow: [],
@@ -39,7 +39,7 @@ const Mark = {
 module.exports = function (context, options = defaultOptions) {
     const { Syntax, RuleError, report, getSource } = context;
     const helper = new RuleHelper(context);
-    const allow = (options.allow || defaultOptions.allow).concat(DEFAULT_ALLOW_LIST);
+    const allow = (options.allow || defaultOptions.allow).concat(BUILTIN_ALLOW_LIST);
     const allowHalfWidthExclamation = options.allowHalfWidthExclamation || defaultOptions.allowHalfWidthExclamation;
     const allowFullWidthExclamation = options.allowFullWidthExclamation || defaultOptions.allowFullWidthExclamation;
     const allowHalfWidthQuestion = options.allowHalfWidthQuestion || defaultOptions.allowHalfWidthQuestion;