Migrate to TypeScript

Author: ka-weihe

.eslintrc.js

@@ -0,0 +1,30 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
+  "extends": [
+    "eslint:all",
+    "prettier",
+    "plugin:node/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "capitalized-comments": "off",
+    "camelcase": "off",
+    "curly": ["error", "all"],
+    "id-length": "off",
+    "max-lines-per-function": "off",
+    "max-statements": "off",
+    "multiline-comment-style": "off",
+    "no-bitwise": "off",
+    "no-magic-numbers": "off",
+    "no-param-reassign": "off",
+    "no-plusplus": "off",
+    "node/no-unsupported-features/es-syntax": "off",
+    "one-var": "off",
+    "padded-blocks": "off"
+  }
+}

.eslintrc.json

@@ -5,6 +5,6 @@ package-lock.json
 js/
 coverage/
 data.json
-bench.js
+bench.ts
 mod.ts
 tsconfig.json

.npmignore

@@ -5,7 +5,7 @@
 [![Build Status](https://travis-ci.org/ka-weihe/node-levenshtein.svg?branch=master)](https://travis-ci.org/ka-weihe/node-levenshtein)
 [![Coverage Status](https://coveralls.io/repos/github/ka-weihe/node-levenshtein/badge.svg?branch=master)](https://coveralls.io/github/ka-weihe/node-levenshtein?branch=master)
 [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ka-weihe/fastest-levenshtein.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ka-weihe/fastest-levenshtein/context:javascript)
-```
+```bash
 $ npm i fastest-levenshtein
 ```
 

README.md

@@ -1,18 +1,16 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable no-console */
-/* eslint-disable no-loop-func */
-/* eslint-disable import/no-extraneous-dependencies */
-/* eslint-disable node/no-unpublished-require */
-const fs = require("fs");
-const leven = require("leven");
 const Benchmark = require("benchmark");
-const fastLevenshtein = require("fast-levenshtein").get;
-const jslevenshtein = require("js-levenshtein");
-const levenshteinEditDistance = require("levenshtein-edit-distance");
-const { distance } = require("./dist");
+import { distance } from "./dist";
+import { get as fastLevenshtein } from "fast-levenshtein";
+const fs = require("fs");
+import jslevenshtein from "js-levenshtein";
+import leven from "leven";
+import levenshteinEditDistance from "levenshtein-edit-distance";
 
 const suite = new Benchmark.Suite();
 
-function randomstring(length) {
+const randomstring = (length) => {
   let result = "";
   const characters =
     "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
@@ -21,16 +19,16 @@ function randomstring(length) {
     result += characters.charAt(Math.floor(Math.random() * charactersLength));
   }
   return result;
-}
+};
 
-function randomstringArr(stringSize, arraySize) {
+const randomstringArr = (stringSize, arraySize) => {
   let i = 0;
   const arr = [];
   for (i = 0; i < arraySize; i++) {
     arr.push(randomstring(stringSize));
   }
   return arr;
-}
+};
 
 const arrSize = 1000;
 if (!fs.existsSync("data.json")) {
@@ -49,39 +47,38 @@ if (!fs.existsSync("data.json")) {
   fs.writeFileSync("data.json", JSON.stringify(data));
 }
 
-const data = JSON.parse(fs.readFileSync("data.json"));
+const data = JSON.parse(fs.readFileSync("data.json", "utf8"));
 
 // BENCHMARKS
-let b = 0;
 for (let i = 0; i < 9; i++) {
   const datapick = data[i];
 
   if (process.argv[2] !== "no") {
     suite
       .add(`${i} - js-levenshtein`, () => {
         for (let j = 0; j < arrSize - 1; j += 2) {
-          b += jslevenshtein(datapick[j], datapick[j + 1]);
+          jslevenshtein(datapick[j], datapick[j + 1]);
         }
       })
       .add(`${i} - leven`, () => {
         for (let j = 0; j < arrSize - 1; j += 2) {
-          b += leven(datapick[j], datapick[j + 1]);
+          leven(datapick[j], datapick[j + 1]);
         }
       })
       .add(`${i} - fast-levenshtein`, () => {
         for (let j = 0; j < arrSize - 1; j += 2) {
-          b += fastLevenshtein(datapick[j], datapick[j + 1]);
+          fastLevenshtein(datapick[j], datapick[j + 1]);
         }
       })
       .add(`${i} - levenshtein-edit-distance`, () => {
         for (let j = 0; j < arrSize - 1; j += 2) {
-          b += levenshteinEditDistance(datapick[j], datapick[j + 1]);
+          levenshteinEditDistance(datapick[j], datapick[j + 1]);
         }
       });
   }
   suite.add(`${i} - fastest-levenshtein`, () => {
     for (let j = 0; j < arrSize - 1; j += 2) {
-      b += distance(datapick[j], datapick[j + 1]);
+      distance(datapick[j], datapick[j + 1]);
     }
   });
 }
@@ -98,7 +95,6 @@ suite
   })
   .on("complete", () => {
     console.log(results);
-    console.log(b);
   })
   // run async
   .run({ async: true });

bench.js bench.ts

@@ -111,8 +111,7 @@ const myers_x = (b: string, a: string) => {
   return score;
 };
 
-
-export function distance(a: string, b: string): number {
+const distance = (a: string, b: string): number => {
   if (a.length < b.length) {
     const tmp = b;
     b = a;
@@ -125,9 +124,9 @@ export function distance(a: string, b: string): number {
     return myers_32(a, b);
   }
   return myers_x(a, b);
-}
+};
 
-export function closest(str: string, arr: string[]): string {
+const closest = (str: string, arr: string[]): string => {
   let min_distance = Infinity;
   let min_index = 0;
   for (let i = 0; i < arr.length; i++) {
@@ -138,4 +137,6 @@ export function closest(str: string, arr: string[]): string {
     }
   }
   return arr[min_index];
-}
+};
+
+export { closest, distance };

mod.ts

@@ -41,19 +41,18 @@
     "test:coveralls": "npm run build && jest --coverage --coverageReporters=text-lcov | coveralls"
   },
   "devDependencies": {
+    "@types/benchmark": "^1.0.33",
+    "@types/jest": "^26.0.13",
+    "@typescript-eslint/eslint-plugin": "^4.1.1",
+    "@typescript-eslint/parser": "^4.1.1",
     "benchmark": "^2.1.4",
     "coveralls": "^3.1.0",
-    "eslint": "^7.5.0",
-    "eslint-config-airbnb": "^18.2.0",
-    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint": "^7.9.0",
     "eslint-config-node": "^4.1.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-import": "^2.22.0",
-    "eslint-plugin-jsx-a11y": "^6.3.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.1.4",
-    "eslint-plugin-react": "^7.20.3",
-    "eslint-plugin-react-hooks": "^4.0.0",
     "fast-levenshtein": "^2.0.6",
     "jest": "^26.1.0",
     "js-levenshtein": "^1.1.6",

package.json

@@ -1,8 +1,12 @@
-const { distance, closest } = require("./dist");
+import { closest, distance } from "./dist";
 
 const levenshtein = (a, b) => {
-  if (a.length === 0) return b.length;
-  if (b.length === 0) return a.length;
+  if (a.length === 0) {
+    return b.length;
+  }
+  if (b.length === 0) {
+    return a.length;
+  }
 
   if (a.length > b.length) {
     const tmp = a;
@@ -18,7 +22,7 @@ const levenshtein = (a, b) => {
   for (let i = 1; i <= b.length; i++) {
     let prev = i;
     for (let j = 1; j <= a.length; j++) {
-      let val;
+      let val = 0;
       if (b.charAt(i - 1) === a.charAt(j - 1)) {
         val = row[j - 1];
       } else {
@@ -33,7 +37,7 @@ const levenshtein = (a, b) => {
   return row[a.length];
 };
 
-function makeid(length) {
+const makeid = (length) => {
   let result = "";
   const characters =
     "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
@@ -42,10 +46,9 @@ function makeid(length) {
     result += characters.charAt(Math.floor(Math.random() * charactersLength));
   }
   return result;
-}
+};
 
 test("test compare", () => {
-  const errors = 0;
   for (let i = 0; i < 1000; i++) {
     const rnd_num1 = (Math.random() * 1000) | 0;
     const rnd_num2 = (Math.random() * 1000) | 0;