Merge pull request #109 from hcodes/checking_substrings

Checking substrings
hcodes · Aug 9, 2018 · b6efdd7 · b6efdd7
2 parents ec663b8 + ba11c3d
commit b6efdd7
Show file tree

Hide file tree

Showing 7 changed files with 109 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v5.0.0
+- FIX: **Breaking changes**: Incorrect work of dictionary words in substrings #106.
+- FIX: Comments in JSON  #108.
+
 ## v4.2.1
 FIX: TypeError: Cannot destructure property config of 'undefined' or 'null' #103.
 

diff --git a/lib/config.js b/lib/config.js
@@ -6,6 +6,17 @@ const debug = require('./debug');
 const printDebug = debug.print;
 const exitCodes = require('./exit-codes');
 const knownProps = require('./config-properties');
+const stripJsonComments = require('strip-json-comments');
+const parseJson = require('parse-json');
+
+function loadJson(filepath, content) {
+    try {
+        return parseJson(stripJsonComments(content));
+    } catch (err) {
+        err.message = `JSON Error in ${filepath}:\n${err.message}`;
+        throw err;
+    }
+}
 
 module.exports = {
     /**
@@ -16,6 +27,10 @@ module.exports = {
      */
     get(file) {
         const explorer = cosmiconfig('yaspeller', {
+            loaders: {
+                '.json': loadJson,
+                noExt: loadJson
+            },
             searchPlaces: [
                 'package.json',
                 '.yaspellerrc',

diff --git a/lib/dictionary.js b/lib/dictionary.js
@@ -168,7 +168,15 @@ module.exports = {
             // unknownWord(s)? = unknownWord(s)? and UnknownWord(s)?
             // UnknownWord(s)? = UnknownWord(s)?
 
-            const preparedWord = word.replace(rePrepare, ($, $1, $2) => '[' + $1 + $1.toUpperCase() + ']' + $2);
+            let preparedWord = word.replace(rePrepare, ($, $1, $2) => '[' + $1 + $1.toUpperCase() + ']' + $2);
+
+            if (preparedWord.search(/\^/) !== 0) {
+                preparedWord = '^' + preparedWord;
+            }
+
+            if (preparedWord.search(/\$/) !== preparedWord.length - 1) {
+                preparedWord += '$';
+            }
 
             try {
                 result.push(new RegExp(preparedWord));

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
     "yaspeller": "./bin/yaspeller"
   },
   "description": "Search tool typos in the text, files and websites",
-  "version": "4.2.1",
+  "version": "5.0.0",
   "license": "MIT",
   "homepage": "https://github.com/hcodes/yaspeller",
   "repository": {
@@ -34,7 +34,7 @@
   "dependencies": {
     "async": "^2.6.1",
     "chalk": "^2.4.1",
-    "commander": "^2.15.1",
+    "commander": "^2.17.1",
     "cosmiconfig": "^5.0.5",
     "entities": "^1.1.1",
     "escape-html": "^1.0.3",
@@ -50,10 +50,11 @@
   },
   "devDependencies": {
     "chai": "^4.1.0",
-    "eslint": "^5.0.0",
+    "eslint": "^5.3.0",
     "istanbul": "^0.4.5",
     "mocha": "^5.2.0",
-    "sinon": "^6.0.1"
+    "parse-json": "^4.0.0",
+    "sinon": "^6.1.4"
   },
   "engines": {
     "node": ">=4"

diff --git a/test/test.config.js b/test/test.config.js
@@ -19,6 +19,10 @@ describe('Config', function() {
     it('get, custom config', function() {
         assert.deepEqual(config.get('./test/json/no_comment.json'), ['1']);
     });
+
+    it('get, custom config with comments', function() {
+        assert.deepEqual(config.get('./test/json/comment.json'), ['1']);
+    });
 
     it('get, default config', function() {
         assert.ok(Object.keys(config.get(null)).length);

diff --git a/test/test.dictionary.js b/test/test.dictionary.js
@@ -53,17 +53,53 @@ describe('Dictionary', function() {
     });
 
     it('isTypo()', function() {
-        const dict = dictionary.prepareDictionary([
-            'контрол'
-        ]);
-
-        assert.isFalse(dictionary.isTypo('Контрол', dict));
-
-        const dict2 = dictionary.prepareDictionary([
-            'Контрол'
-        ]);
-
-        assert.isTrue(dictionary.isTypo('контрол', dict2));
+        [
+            {
+                dict: [
+                    'контрол'
+                ],
+                word: 'Контрол',
+                result: false
+            },
+            {
+                dict: [
+                    'Контрол'
+                ],
+                word: 'контрол',
+                result: true
+            },
+            {
+                dict: [
+                    'митап'
+                ],
+                word: 'митап',
+                result: false
+            },
+            {
+                dict: [
+                    'митап'
+                ],
+                word: 'тестмитап',
+                result: true
+            },
+            {
+                dict: [
+                    'митап'
+                ],
+                word: 'немитап',
+                result: true
+            },
+            {
+                dict: [
+                    'митап'
+                ],
+                word: 'багмитапбаг',
+                result: true
+            }
+        ].forEach(item => {
+            const dict = dictionary.prepareDictionary(item.dict);
+            assert.equal(item.result, dictionary.isTypo(item.word, dict), item.word);
+        });
     });
 
     it('removeDuplicates()', function() {
@@ -101,17 +137,17 @@ describe('Dictionary', function() {
 
     it('set(), dictionary from config', function() {
         dictionary.set([], ['a']);
-        assert.deepEqual(dictionary._dict, [/[aA]/]);
+        assert.deepEqual(dictionary._dict, [/^[aA]$/]);
     });
 
     it('set()', function() {
         dictionary.set(['test/dict/a.json', 'test/dict/b.json'], ['a']);
         assert.deepEqual(dictionary._dict, [
-            /[aA]/,
-            /[xX]yz/,
-            /[aA]bc/,
-            /CLI/,
-            /[dD]eps/
+            /^[aA]$/,
+            /^[xX]yz$/,
+            /^[aA]bc$/,
+            /^CLI$/,
+            /^[dD]eps$/
         ]);
     });