sapegin
diff --git a/‎.eslintignore
Copy file name to clipboard
-3Lines changed: 0 additions & 3 deletions b/‎.eslintignore
Copy file name to clipboard
-3Lines changed: 0 additions & 3 deletions
diff --git a/‎.eslintrc
Copy file name to clipboard
-3Lines changed: 0 additions & 3 deletions b/‎.eslintrc
Copy file name to clipboard
-3Lines changed: 0 additions & 3 deletions
diff --git a/‎.gitignore
Copy file name to clipboard
+2-2Lines changed: 2 additions & 2 deletions b/‎.gitignore
Copy file name to clipboard
+2-2Lines changed: 2 additions & 2 deletions
diff --git a/‎.husky/pre-commit
Copy file name to clipboard
+1Lines changed: 1 addition & 0 deletions b/‎.husky/pre-commit
Copy file name to clipboard
+1Lines changed: 1 addition & 0 deletions
diff --git a/‎.prettierrc
Copy file name to clipboard
+11-14Lines changed: 11 additions & 14 deletions b/‎.prettierrc
Copy file name to clipboard
+11-14Lines changed: 11 additions & 14 deletions
diff --git a/‎Readme.md
Copy file name to clipboard
+92-15Lines changed: 92 additions & 15 deletions b/‎Readme.md
Copy file name to clipboard
+92-15Lines changed: 92 additions & 15 deletions
diff --git a/‎eslint.config.mjs
Copy file name to clipboard
+8Lines changed: 8 additions & 0 deletions b/‎eslint.config.mjs
Copy file name to clipboard
+8Lines changed: 8 additions & 0 deletions
diff --git a/‎index.js
Copy file name to clipboard
-154Lines changed: 0 additions & 154 deletions b/‎index.js
Copy file name to clipboard
-154Lines changed: 0 additions & 154 deletions
@@ -6,9 +6,9 @@ Thumbs.db
 *.sublime-workspace
 *.log
 Changelog.md
-coverage/
+out/
 node_modules/
 .idea/
 .vscode/
 .eslintcache
-yarn.lock
+yarn.lock
@@ -0,0 +1 @@
+npx lint-staged
@@ -1,16 +1,13 @@
 {
-	"useTabs": true,
-	"singleQuote": true,
-	"trailingComma": "es5",
-	"overrides": [
-		{
-			"files": "*.md",
-			"options": {
-				"printWidth": 70,
-				"useTabs": false,
-				"trailingComma": "none",
-				"proseWrap": "never"
-			}
-		}
-	]
+  "singleQuote": true,
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "printWidth": 70,
+        "trailingComma": "none",
+        "proseWrap": "never"
+      }
+    }
+  ]
 }
@@ -2,7 +2,7 @@
 
 [![textlint fixable rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/) [![npm](https://img.shields.io/npm/v/textlint-rule-stop-words.svg)](https://www.npmjs.com/package/textlint-rule-stop-words) [![Node.js CI status](https://github.com/sapegin/textlint-rule-stop-words/workflows/Node.js%20CI/badge.svg)](https://github.com/sapegin/textlint-rule-stop-words/actions)
 
-[textlint](https://github.com/textlint/textlint) rule to find filler words, buzzwords and clichés — 1600+ words and phrases in English.
+[textlint](https://github.com/textlint/textlint) rule to find filler words, buzzwords, and clichés — 1700+ words and phrases in English.
 
 For example:
 
@@ -35,33 +35,110 @@ You can configure the rule in your `.textlintrc`:
 {
   "rules": {
     "stop-words": {
-      // Load default dictionary (see dict.txt in the repository)
-      "defaultWords": true,
-      // Syntax elements to skip. Overrides the default
-      "skip": ["Blockquote"],
-      // Extra words
+      // Your options here
+    }
+  }
+}
+```
+
+Read more about [configuring textlint](https://github.com/textlint/textlint/blob/master/docs/configuring.md).
+
+### `defaultWords` (default: `true`)
+
+Whether to load the [default dictionary](./dict.txt). Example:
+
+```js
+{
+  "rules": {
+    "stop-words": {
+      // Don't load default dictionary
+      "defaultWords": false,
+    }
+  }
+}
+```
+
+### `skip` (default `['BlockQuote']`)
+
+Syntax elements to skip. By default skips blockquotes. Example:
+
+```js
+{
+  "rules": {
+    "stop-words": {
+      // Don't check terms inside links
+      "skip": ["Link"],
+    }
+  }
+}
+```
+
+See [all available element types](https://github.com/textlint/textlint/blob/master/packages/%40textlint/ast-node-types/src/ASTNodeTypes.ts).
+
+### `words`
+
+Additional words.
+
+Could be an array of words:
+
+```js
+{
+  "rules": {
+    "stop-words": {
+      // List of words
       "words": [
+        // Exact words
         ["etc."],
         ["you can"],
         // With a replacement
-        ["blacklist", "denylist"],
-        // Ensure correct capitalization
-        ["asciidoc", "AsciiDoc"]
+        ["blacklist", "denylist"]
       ],
-      // Excluded words
+    }
+  }
+}
+```
+
+A path to a text file:
+
+```js
+{
+  "rules": {
+    "stop-words": {
+      // Load words from a file
+      "words": "~/stop-words.txt"
+    }
+  }
+}
+```
+
+Check out [the default dictionary](./dict.txt).
+
+### `exclude`
+
+If you don’t like some of [the default words](./dict.txt), you can _exclude_ them. For example, to exclude these entries:
+
+```txt
+// dict.txt
+utilize > use
+period of time
+```
+
+You need to copy the exact entry (for words with replacement, just the first element) to the `exclude` option of the `stop-words` rule in your Textlint config:
+
+```js
+{
+  "rules": {
+    "stop-words": {
+      // Excludes terms
       "exclude": [
         "utilize",
         "period of time"
-      ],
-      // OR load terms from a file
-      "words": "~/stop-words.txt"
+      ]
     }
   }
 }
 ```
 
-Check the [default dictionary](./dict.txt). Read more about [configuring textlint](https://github.com/textlint/textlint/blob/master/docs/configuring.md).
-
 ## Tips & tricks
 
 Use [textlint-filter-rule-comments](https://github.com/textlint/textlint-filter-rule-comments) to disable stop-words check for particular paragraphs:
 
@@ -0,0 +1,8 @@
+import tamiaTypeScript from 'eslint-config-tamia/typescript';
+
+export default [
+	...tamiaTypeScript,
+	{
+		ignores: ['out/'],
+	},
+];