Added tests (Fixes #1)

Signed-off-by: Alessandro Sanino <[email protected]>

.github/workflows/npm-publish.yaml

@@ -16,7 +16,7 @@ jobs:
         with:
           node-version: 14
       - run: yarn install --frozen-lockfile
-      #- run: yarn test
+      - run: yarn test
 
   publish-npm:
     needs: build

.npmignore

@@ -0,0 +1,2 @@
+testdata/*
+*.test.ts

index.test.ts

@@ -0,0 +1,27 @@
+import { describe, it } from "mocha";
+import small_test from "./testdata/small_test";
+import big_test from "./testdata/big_test";
+import { expect } from "chai";
+import gestaltSimilarity from ".";
+
+describe("Library Tests (Average string length = 18 characters)", () => {
+    it(`Short Test (${small_test.length} elements)`, () => {
+        test_from_cases(small_test);
+    })
+    it(`Big Test (${big_test.length} elements)`, () => {
+        test_from_cases(big_test);
+    })
+});
+
+type TestCase = {
+    first: string;
+    second: string;
+    expected_result: number;
+}
+
+function test_from_cases(cases : TestCase[]) {
+    for (const { first, second, expected_result } of cases) {
+        const actual_result = gestaltSimilarity(first, second);
+        expect(actual_result).to.be.equal(expected_result, `gestaltSimilarity("${first}", "${second}") did not pass the test`);
+    }
+}

package.json

@@ -1,6 +1,7 @@
 {
   "name": "gestalt-pattern-matcher",
-  "version": "0.0.9",
+  "version": "0.0.10",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "[email protected]:saniales/gestalt-pattern-matcher.git"
@@ -15,14 +16,27 @@
     "url": "https://alessandro.sanino.dev"
   },
   "description": "Finds the similarity between strings and represents it as a number",
-  "keywords": [ "pattern-matching", "gestalt", "string-similarity", "similarity" ],
-  "license": "MIT",
+  "keywords": [
+    "pattern-matching",
+    "gestalt",
+    "string-similarity",
+    "similarity"
+  ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
+    "test": "mocha -r ts-node/register '*.test.ts'",
     "prepublish": "tsc"
   },
   "devDependencies": {
+    "@types/chai": "^4.2.12",
+    "@types/mocha": "^8.0.3",
+    "chai": "^4.2.0",
+    "mocha": "^8.1.3",
+    "ts-node": "^9.0.0",
     "typescript": "^4.0.3"
+  },
+  "dependencies": {
+    "faker": "^5.1.0"
   }
 }