Merge pull request #11 from aliaks-ei/migrate_to_typescript

Migrate repo to Typescript

Author: aliaks-ei

.github/workflows/editorconfig-check.yml

@@ -9,6 +9,6 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: '16'
       - run: npm ci
       - run: npm run editorconfig:check

.github/workflows/unit-tests.yml

@@ -9,6 +9,6 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: '16'
       - run: npm ci
       - run: npm run test:unit

jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.ts?$': 'ts-jest',
+  },
+  transformIgnorePatterns: ['<rootDir>/node_modules/'],
+};

package-lock.json

@@ -1,14 +1,16 @@
 {
   "name": "js-algorithms",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A collection of the most famous algorithms implemented in Javascript",
-  "author": "Alexey Mozheyko",
+  "author": "Aliaksei Mazheika",
   "scripts": {
-    "test:unit": "jest --silent",
+    "test:unit": "jest",
     "editorconfig:check": "editorconfig-checker --exclude '.git|node_modules|.DS_store'"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.3",
     "editorconfig-checker": "^4.0.2",
-    "jest": "^27.0.6"
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6"
   }
 }

package.json

@@ -8,9 +8,9 @@ Binary search compares the target value to the middle element of the array. If t
 
 ## Implementation
 
-**_binarySearch(numArray, key)_** should return **true** if ```key``` is present in ```numArray``` and **false** otherwise.
+`binarySearch(numArray, key)` should return `true` if `key` is present in `numArray` and `false` otherwise.
 
-For example:
+Example:
 
 ```
 binarySearch([5, 7, 12, 16, 36, 56, 71], 56)  //  true

src/binary-search/README.md

@@ -0,0 +1,23 @@
+import binarySearch from ".";
+
+describe("Binary search: ", () => {
+  test("should return true (array contains key)", () => {
+    const numArray = [5, 7, 12, 16, 36, 56, 71];
+    const key = 56;
+
+    expect(binarySearch(numArray, key)).toBeTruthy();
+  });
+
+  test("should return false (array does not contains key)", () => {
+    const numArray = [5, 7, 12, 16, 36, 56, 71];
+    const key = 99;
+
+    expect(binarySearch(numArray, key)).toBeFalsy();
+  });
+
+  test("should return false (empty array passed)", () => {
+    const key = -33;
+
+    expect(binarySearch([], key)).toBeFalsy();
+  });
+});

src/binary-search/binary-search.spec.js

@@ -1,26 +1,24 @@
-function binarySearch(numArray = [], key) {
-  let numArrLength = numArray.length;
+function binarySearch(numArray: number[] = [], key: number): boolean {
+  const numArrLength = numArray.length;
 
   if (!numArrLength) {
     return false;
   }
 
-  let middleIndex = Math.floor(numArrLength / 2);
-  let middleElem  = numArray[middleIndex];
+  const middleIndex = Math.floor(numArrLength / 2);
+  const middleElem = numArray[middleIndex];
 
   if (key < middleElem && numArrLength > 1) {
     let leftHalf = numArray.slice(0, middleIndex);
 
     return binarySearch(leftHalf, key);
-  }
-  else if (key > middleElem && numArrLength > 1) {
+  } else if (key > middleElem && numArrLength > 1) {
     let rightHalf = numArray.slice(middleIndex);
 
     return binarySearch(rightHalf, key);
-  }
-  else {
+  } else {
     return key === middleElem;
   }
 }
 
-module.exports = binarySearch;
+export default binarySearch;

src/binary-search/index.spec.ts

@@ -8,9 +8,9 @@ The pass through the list is repeated until the list is sorted. The algorithm, w
 
 ## Implementation
 
-**_bubbleSort(array)_** should return the origin ```array```, sorted with _bubble sort_.
+`bubbleSort(array)` should return the origin `array`, sorted with _bubble sort_.
 
-For example:
+Example:
 
 ```
 bubbleSort([5, 3, 8, 2, 1, 4]) //  [1, 2, 3, 4, 5, 8]