propose - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "propose",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Propse a word when the input word is not in the dictionary",
@@ -18,6 +18,13 @@ "main": "propose.js",
     "similar",
-    "correction"
+    "correction",
+    "did you mean"
   ],
   "author": "Shuping LIU",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "devDependencies": {
+    "mocha": "^2.2.5"
+  },
+  "dependencies": {
+    "levenshtein-edit-distance": "^0.1.4"
+  }
+}

README.md

 # propose
 Propse a word when the input word is not in the dictionary
+
+[![build status](https://travis-ci.org/liushuping/propose.svg?branch=master)](https://travis-ci.org/liushuping/propose.svg?branch=master)
+
+This module can be used to propse the right command in the scenario when there is a typo or mis-spell in the command line, it looks up the given dictionary and identifies the most similar word. It can also be used in any case that the string is formed by one or a series of known words, for example URL, directory path etc.
+
+## Example
+```javascript
+var dictionary = ['hello', 'world'];
+var word = 'hallo';
+propose(word, dictionary); //hello
+```
+
+## Options
+`threshold` [0~1] specifies only the word with similarity equals to or higher than that value will be returned
+```javascript
+var dictionary = ['aaaaaaaa', 'baabbbb', 'ccccc'];
+var word = 'ab';
+propose(word, dictionary, {
+    threshold: 0.5
+}); // null as the most similar word does not meet the threshold value
+```
+
+`ignoreCase` [true, false] specifies whether ignore case when comparing two words
+```javascript
+var dictionary = ['HELLO', 'hallo'];
+var word = 'hello';
+propose(word, dictionary, {
+    ignoreCase: true
+}); //'HELLO'
+```
+
+## Test
+Make sure `mocha` is installed globally
+```
+npm install mocha -g
+```
+Run `npm test` to run unit test
+
+## Dependencies
+levenshtein-edit-distance
+
+## License
+MIT

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5575

increased by247.35%

Number of package files

7

increased by40%

Lines of code

71

increased byInfinity%

Number of lines in readme file

45

increased by1400%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

1

increased byInfinity%

Dependency changes

• + Addedlevenshtein-edit-distance@^0.1.4

• + Addedlevenshtein-edit-distance@0.1.4(transitive)