Merge pull request #44 from hcodes/issue-41

Improvements in the dictionary #41

.yaspellerrc

@@ -14,14 +14,15 @@
   ],
   "dictionary": [
     "args",
-    "/(C|c)hangelog/",
+    "changelog",
     "CLI",
     "deps",
     "htm",
     "hcodes",
     "Habrahabr",
     "LF",
     "linter",
+    "Markdown",
     "md",
     "NONINFRINGEMENT",
     "npm",
@@ -30,7 +31,7 @@
     "Seleznev",
     "sitemap",
     "sublicense",
-    "/(Y|y)aspeller/",
-    "Yo"
+    "yaspeller",
+    "yo"
   ]
 }

CHANGELOG.md

@@ -1,14 +1,40 @@
 # Changelog
 
+## 2.5.0
+- Replace npm module `eyo` to `eyo-kernel`
+- Output warnings of duplicate words in dictionaries
+- Update deps in package.json
+- Simplified regular expressions in words in the dictionary
+
+Before(<= 2.4.0):
+```js
+[
+  "someword1", // someword1 = someword1
+  "Someword2", // Someword2 = Someword2
+  "/some(w|W)ord[23]/", // some(w|W)ord[23] = some(w|W)ord[23]
+  "/Some(w|W)ord/" // Some(w|W)ord = Some(w|W)ord
+]
+```
+
+After(2.5.0):
+```js
+[
+  "someword1", // someword1 = someword1 and Someword1
+  "Someword2", // Someword2 = Someword2
+  "some(w|W)ord[23]", // some(w|W)ord[23] = some(w|W)ord[23] and Some(w|W)ord[23]
+  "Some(w|W)ord" // Some(w|W)ord = Some(w|W)ord
+]
+```
+
 ## 2.4.0
 - Ability to ignore text when checking
 
 ### Bug fixes
-- Fix JSON comments in dictionaries and configs
+- Fix JSON comments in dictionaries and config's
 
 ## 2.3.0
-- JSON comments in dictionaries and configs #35
-- Аbility to specify multiple dictionaries in option --dictionary #33
+- JSON comments in dictionaries and config's #35
+- Ability to specify multiple dictionaries in option --dictionary #33
 - Markdown report #31
 - Update deps in package.json
 

README.md

@@ -46,22 +46,23 @@ Example: `.md,.htm,.txt`.
 
 #### `--dictionary <file>`
 JSON file for own dictionary.
-```JSON
+```js
 [
-    "someword1",
-    "someword2",
+    "someword1", // someword1 = someword1 and Someword1
+    "Someword2", // Someword2 = Someword2
     "someword3"
 ]
 ```
 
 Regular expressions are supported:
 ```js
 [
-    "someword1", // JSON comments
-    "/(S|s)omeword2/",
-    "/someword3/i"
+    "unknownword",
+    "unknown(W|w)ord[12]?", // unknown(W|w)ord[12]? = unknown(W|w)ord[12]? and Unknown(W|w)ord[12]?
+    "Unknown(W|w)ord[34]?" // Unknown(W|w)ord[34]? = Unknown(W|w)ord[34]?
 ]
 ```
+
 Examples:<br/>
 `yaspeller --dictionary my_dict.json .`<br/>
 `yaspeller --dictionary my_dict.json:my_dict2.json .`
@@ -169,8 +170,11 @@ Yaspeller is configured using `.yaspellerrc` JSON file at the root of the projec
   ],
   "report": ["console", "html"],
   "dictionary": [
-    "someword1", // JSON comments
-    "/(S|s)omeword2/"
+    // JSON comments
+    "someword1", // someword1 = someword1 and Someword1
+    "Someword2", // Someword2 = Someword2
+    "some(w|W)ord[23]", // some(w|W)ord[23] = some(w|W)ord[23] and Some(w|W)ord[23]
+    "Some(w|W)ord" // Some(w|W)ord = Some(w|W)ord
   ],
   "ignoreTags": ["code", "script"],
   "ignoreUrls": true,

README.ru.md

@@ -44,19 +44,19 @@ yaspeller
 
 #### `--dictionary <file>`
 JSON-файл собственного словаря.
-```JSON
+```js
 [
-    "someword1",
-    "someword2",
+    "someword1", // someword1 = someword1 and Someword1
+    "Someword2", // Someword2 = Someword2
     "someword3"
 ]
 ```
 Поддерживаются регулярные выражения:
 ```js
 [
-    "someword1", // JSON comments
-    "/(S|s)omeword2/",
-    "/someword3/i"
+    "unknownword",
+    "unknown(W|w)ord[12]?", // unknown(W|w)ord[12]? = unknown(W|w)ord[12]? and Unknown(W|w)ord[12]?
+    "Unknown(W|w)ord[34]?" // Unknown(W|w)ord[34]? = Unknown(W|w)ord[34]?
 ]
 ```
 Примеры использования:<br/>
@@ -165,8 +165,11 @@ JSON-файл собственного словаря.
   ],
   "report": ["console", "html"],
   "dictionary": [
-    "someword1", // JSON comments
-    "/(S|s)omeword2/"
+    // JSON comments
+    "someword1", // someword1 = someword1 and Someword1
+    "Someword2", // Someword2 = Someword2
+    "some(w|W)ord[23]", // some(w|W)ord[23] = some(w|W)ord[23] and Some(w|W)ord[23]
+    "Some(w|W)ord" // Some(w|W)ord = Some(w|W)ord
   ],
   "ignoreTags": ["code", "script"],
   "ignoreUrls": true,