TypeScript Conversion (#425)

Follows #424. Converts the upcoming 1.0.0 branch based on native browser-based traffic capture and recording to TypeScript. Fixes #426

---------
Co-authored-by: Tessa Walsh <[email protected]>
Co-authored-by: emma <[email protected]>

Author: 3 people

.eslintrc.cjs

@@ -1,39 +1,32 @@
 module.exports = {
-    "env": {
-        "browser": true,
-        "es2021": true,
-        "node": true,
-        "jest": true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": 12,
-        "sourceType": "module"
-    },
-    "rules": {
-      "indent": [
-          "error",
-          2
-      ],
-      "linebreak-style": [
-          "error",
-          "unix"
-      ],
-      "quotes": [
-          "error",
-          "double"
-      ],
-      "semi": [
-          "error",
-          "always"
-      ],
-      "no-constant-condition": [
-          "error",
-          {"checkLoops": false }
-      ],
-      "no-use-before-define": [
-          "error",
-          {"variables": true, "functions": false, "classes": false, "allowNamedExports": true}
-      ]
-  }
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+    jest: true,
+  },
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  parserOptions: {
+    ecmaVersion: 12,
+    sourceType: "module",
+  },
+  rules: {
+    indent: ["error", 2],
+    "linebreak-style": ["error", "unix"],
+    quotes: ["error", "double"],
+    semi: ["error", "always"],
+    "no-constant-condition": ["error", { checkLoops: false }],
+    "no-use-before-define": [
+      "error",
+      {
+        variables: true,
+        functions: false,
+        classes: false,
+        allowNamedExports: true,
+      },
+    ],
+  },
+  reportUnusedDisableDirectives: true,
 };

.github/workflows/ci.yaml

@@ -40,6 +40,8 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - name: install requirements
       run: yarn install
+    - name: build js
+      run: yarn run tsc
     - name: build docker
       run: docker-compose build
     - name: run jest

Dockerfile

@@ -38,14 +38,18 @@ RUN mkdir -p /tmp/ads && cd /tmp/ads && \
 
 RUN yarn install --network-timeout 1000000
 
-ADD *.js /app/
-ADD util/*.js /app/util/
+ADD tsconfig.json /app/
+ADD src /app/src
+
+RUN yarn run tsc
 
 ADD config/ /app/
 
 ADD html/ /app/html/
 
-RUN ln -s /app/main.js /usr/bin/crawl; ln -s /app/create-login-profile.js /usr/bin/create-login-profile
+RUN chmod u+x /app/dist/main.js /app/dist/create-login-profile.js
+
+RUN ln -s /app/dist/main.js /usr/bin/crawl; ln -s /app/dist/create-login-profile.js /usr/bin/create-login-profile
 
 WORKDIR /crawls
 

defaultDriver.js

@@ -7,7 +7,8 @@
   "author": "Ilya Kreymer <[email protected]>, Webrecorder Software",
   "license": "AGPL-3.0-or-later",
   "scripts": {
-    "lint": "eslint *.js util/*.js tests/*.test.js",
+    "tsc": "tsc",
+    "lint": "eslint *.js tests/*.test.js",
     "test": "yarn node --experimental-vm-modules $(yarn bin jest --bail 1)",
     "prepare": "husky install"
   },
@@ -18,23 +19,31 @@
     "crc": "^4.3.2",
     "get-folder-size": "^4.0.0",
     "husky": "^8.0.3",
-    "ioredis": "^4.27.1",
+    "ioredis": "^5.3.2",
     "js-yaml": "^4.1.0",
-    "minio": "7.0.26",
+    "minio": "^7.1.3",
     "p-queue": "^7.3.4",
     "puppeteer-core": "^20.7.4",
     "sharp": "^0.32.1",
-    "sitemapper": "^3.2.5",
+    "sitemapper": "^3.2.6",
+    "tsc": "^2.0.4",
     "uuid": "8.3.2",
-    "warcio": "^2.2.0",
+    "warcio": "^2.2.1",
     "ws": "^7.4.4",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "eslint": "^8.37.0",
+    "@types/js-yaml": "^4.0.8",
+    "@types/node": "^20.8.7",
+    "@types/uuid": "^9.0.6",
+    "@types/ws": "^8.5.8",
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
+    "@typescript-eslint/parser": "^6.10.0",
+    "eslint": "^8.53.0",
     "eslint-plugin-react": "^7.22.0",
     "jest": "^29.2.1",
-    "md5": "^2.3.0"
+    "md5": "^2.3.0",
+    "typescript": "^5.2.2"
   },
   "jest": {
     "transform": {},