Merge pull request #16393 from overleaf/em-typescript-libraries

Add type checking to libraries GitOrigin-RevId: bed79f5123081773d6ac6e27698246726184c5e6
2026-05-23 17:19:37 +02:00 · 2024-01-11 08:26:29 -05:00
parent f1b460ecea
commit d227dfba0c
28 changed files with 276 additions and 123 deletions
--- a/libraries/access-token-encryptor/package.json
+++ b/libraries/access-token-encryptor/package.json
@@ -3,13 +3,17 @@
  "version": "3.0.0",
  "description": "",
  "main": "index.js",
+  "types": "./types/index.js",
  "scripts": {
-    "test": "mocha test/**/*.js",
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test:ci": "npm run test"
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "author": "",
  "license": "AGPL-3.0-only",
@@ -22,6 +26,7 @@
  "devDependencies": {
    "chai": "^4.3.6",
    "mocha": "^10.2.0",
-    "sandboxed-module": "^2.0.4"
+    "sandboxed-module": "^2.0.4",
+    "typescript": "^5.0.4"
  }
 }
--- a/libraries/access-token-encryptor/tsconfig.json
+++ b/libraries/access-token-encryptor/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/fetch-utils/package.json
+++ b/libraries/fetch-utils/package.json
@@ -3,14 +3,17 @@
  "version": "0.1.0",
  "description": "utilities for node-fetch",
  "main": "index.js",
+  "types": "types/index.js",
  "scripts": {
-    "test": "npm run lint && npm run format && npm run test:unit",
-    "test:unit": "mocha",
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test:ci": "npm run test:unit"
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "author": "Overleaf (https://www.overleaf.com)",
  "license": "AGPL-3.0-only",
@@ -19,7 +22,8 @@
    "chai": "^4.3.6",
    "chai-as-promised": "^7.1.1",
    "express": "^4.18.2",
-    "mocha": "^10.2.0"
+    "mocha": "^10.2.0",
+    "typescript": "^5.0.4"
  },
  "dependencies": {
    "@overleaf/o-error": "*",
--- a/libraries/fetch-utils/tsconfig.json
+++ b/libraries/fetch-utils/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/logger/package.json
+++ b/libraries/logger/package.json
@@ -6,15 +6,20 @@
    "type": "git",
    "url": "https://github.com/overleaf/overleaf"
  },
+  "main": "index.js",
+  "types": "types/index.js",
  "license": "AGPL-3.0-only",
  "version": "3.1.1",
  "scripts": {
-    "test": "mocha --grep=$MOCHA_GREP test/**/*.js",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "test:ci": "npm run test"
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "dependencies": {
    "@google-cloud/logging-bunyan": "^5.0.0",
@@ -28,7 +33,8 @@
    "mocha": "^10.2.0",
    "sandboxed-module": "^2.0.4",
    "sinon": "^9.2.4",
-    "sinon-chai": "^3.7.0"
+    "sinon-chai": "^3.7.0",
+    "typescript": "^5.0.4"
  },
  "peerDependencies": {
    "@overleaf/metrics": "*"
--- a/libraries/logger/tsconfig.json
+++ b/libraries/logger/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/metrics/package.json
+++ b/libraries/metrics/package.json
@@ -6,6 +6,8 @@
    "type": "git",
    "url": "https://github.com/overleaf/metrics-module.git"
  },
+  "main": "index.js",
+  "types": "types/index.js",
  "dependencies": {
    "@google-cloud/opentelemetry-cloud-trace-exporter": "^2.1.0",
    "@google-cloud/profiler": "^6.0.0",
@@ -24,17 +26,20 @@
    "chai": "^4.3.6",
    "mocha": "^10.2.0",
    "sandboxed-module": "^2.0.4",
-    "sinon": "^9.2.4"
+    "sinon": "^9.2.4",
+    "typescript": "^5.0.4"
  },
  "scripts": {
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "test:unit": "mocha --reporter spec --recursive --exit --grep=$MOCHA_GREP test/unit",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
    "test:acceptance": "mocha --reporter spec --recursive --exit --grep=$MOCHA_GREP test/acceptance",
-    "test": "npm run test:unit && npm run test:acceptance",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test:ci": "npm run test"
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "peerDependencies": {
    "@overleaf/logger": "*"
--- a/libraries/metrics/tsconfig.json
+++ b/libraries/metrics/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/o-error/package.json
+++ b/libraries/o-error/package.json
@@ -13,6 +13,7 @@
    "verror"
  ],
  "main": "index.cjs",
+  "types": "types/index.cjs",
  "files": [
    "index.cjs",
    "index.d.ts"
@@ -21,15 +22,17 @@
    "build": "npm run --silent typecheck && npm run --silent test && npm run --silent declaration:build && npm run --silent update-readme",
    "declaration:build": "rm -f index.d.ts && tsc --allowJs --declaration --emitDeclarationOnly --moduleResolution node --target ES6 index.js",
    "declaration:check": "git diff --exit-code -- index.d.ts",
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
    "prepublishOnly": "npm run --silent declaration:build && npm run --silent declaration:check",
-    "test": "mocha",
-    "typecheck": "tsc --allowJs --checkJs --noEmit --skipLibCheck --moduleResolution node --strict --target ES6 *.cjs test/**/*.js",
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "typecheck": "tsc --noEmit",
    "update-readme": "doc/update-readme.js",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test:ci": "npm run typecheck && npm run test"
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test:ci": "npm run test:unit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "author": "Overleaf (https://www.overleaf.com)",
  "license": "MIT",
--- a/libraries/o-error/tsconfig.json
+++ b/libraries/o-error/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/object-persistor/package.json
+++ b/libraries/object-persistor/package.json
@@ -3,14 +3,17 @@
  "version": "1.0.2",
  "description": "Module for storing objects in multiple backends, with fallback on 404 to assist migration between them",
  "main": "index.js",
+  "types": "types/index.js",
  "scripts": {
-    "test": "npm run lint && npm run format && npm run test:unit",
-    "test:unit": "mocha",
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test:ci": "npm run test:unit"
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "repository": {
    "type": "git",
@@ -39,6 +42,7 @@
    "mongodb": "^6.1.0",
    "sandboxed-module": "^2.0.4",
    "sinon": "^9.2.4",
-    "sinon-chai": "^3.7.0"
+    "sinon-chai": "^3.7.0",
+    "typescript": "^5.0.4"
  }
 }
--- a/libraries/object-persistor/tsconfig.json
+++ b/libraries/object-persistor/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/overleaf-editor-core/package.json
+++ b/libraries/overleaf-editor-core/package.json
@@ -3,13 +3,17 @@
  "version": "1.0.0",
  "description": "Library shared between the editor server and clients.",
  "main": "index.js",
+  "types": "types/index.js",
  "scripts": {
-    "test": "mocha",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "lint": "eslint --max-warnings 0 --format unix lib test && tsc",
-    "lint:fix": "eslint --fix lib test",
-    "test:ci": "npm run test"
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "author": "team@overleaf.com",
  "license": "Proprietary",
--- a/libraries/overleaf-editor-core/test/operation.test.js
+++ b/libraries/overleaf-editor-core/test/operation.test.js
@@ -62,8 +62,8 @@ describe('Operation', function () {

    return {
      snapshot: snapshotA,
-      operations: operations,
-      primeOperations: primeOperations,
+      operations,
+      primeOperations,

      log() {
        console.log(this)
--- a/libraries/overleaf-editor-core/tsconfig.json
+++ b/libraries/overleaf-editor-core/tsconfig.json
@@ -1,14 +1,7 @@
 {
-  "compilerOptions": {
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
-    "checkJs": true,
-    "esModuleInterop": true,
-    "lib": ["es2022"],
-    "module": "commonjs",
-    "noEmit": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true
-  },
-  "include": ["lib/**/*", "typings/**/*"]
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
 }
--- a/libraries/promise-utils/package.json
+++ b/libraries/promise-utils/package.json
@@ -4,20 +4,23 @@
  "description": "utilities to help working with promises",
  "main": "index.js",
  "scripts": {
-    "test": "npm run lint && npm run format && npm run test:unit",
-    "test:unit": "mocha",
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test:ci": "npm run test:unit"
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "author": "Overleaf (https://www.overleaf.com)",
  "license": "AGPL-3.0-only",
  "devDependencies": {
    "chai": "^4.3.10",
    "chai-as-promised": "^7.1.1",
-    "mocha": "^10.2.0"
+    "mocha": "^10.2.0",
+    "typescript": "^5.0.4"
  },
  "dependencies": {
    "p-limit": "^2.3.0"
--- a/libraries/promise-utils/tsconfig.json
+++ b/libraries/promise-utils/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/ranges-tracker/package.json
+++ b/libraries/ranges-tracker/package.json
@@ -8,14 +8,18 @@
  "author": "Overleaf (https://www.overleaf.com)",
  "private": true,
  "scripts": {
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test": "mocha --recursive test/unit/src/",
-    "test:ci": "npm run test"
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "devDependencies": {
-    "mocha": "^10.2.0"
+    "mocha": "^10.2.0",
+    "typescript": "^5.0.4"
  }
 }
--- a/libraries/ranges-tracker/test/notests.js
+++ b/libraries/ranges-tracker/test/notests.js
@@ -0,0 +1 @@
+// There are no tests yet
--- a/libraries/ranges-tracker/tsconfig.json
+++ b/libraries/ranges-tracker/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/redis-wrapper/package.json
+++ b/libraries/redis-wrapper/package.json
@@ -13,12 +13,15 @@
  "repository": "github:overleaf/redis-wrapper",
  "license": "ISC",
  "scripts": {
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test": "mocha --recursive test/unit/src/",
-    "test:ci": "npm run test"
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "peerDependencies": {
    "@overleaf/logger": "*",
@@ -35,6 +38,7 @@
    "chai": "^4.3.6",
    "mocha": "^10.2.0",
    "sandboxed-module": "^2.0.4",
-    "sinon": "^9.2.4"
+    "sinon": "^9.2.4",
+    "typescript": "^5.0.4"
  }
 }
--- a/libraries/redis-wrapper/tsconfig.json
+++ b/libraries/redis-wrapper/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/settings/package.json
+++ b/libraries/settings/package.json
@@ -4,11 +4,18 @@
  "version": "3.0.0",
  "repository": "overleaf/settings-module",
  "scripts": {
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test": "echo noop",
-    "test:ci": "echo noop"
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
+  },
+  "devDependencies": {
+    "mocha": "^10.2.0",
+    "typescript": "^5.0.4"
  }
 }
--- a/libraries/settings/test/notests.js
+++ b/libraries/settings/test/notests.js
@@ -0,0 +1 @@
+// There are no tests yet
--- a/libraries/settings/tsconfig.json
+++ b/libraries/settings/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}
--- a/libraries/stream-utils/package.json
+++ b/libraries/stream-utils/package.json
@@ -3,20 +3,24 @@
  "version": "0.1.0",
  "description": "stream handling utilities",
  "main": "index.js",
+  "types": "types/index.js",
  "scripts": {
-    "test": "npm run lint && npm run format && npm run test:unit",
-    "test:unit": "mocha",
-    "lint": "eslint --max-warnings 0 --format unix .",
-    "lint:fix": "eslint --fix .",
-    "format": "prettier --list-different $PWD/'**/*.js'",
-    "format:fix": "prettier --write $PWD/'**/*.js'",
-    "test:ci": "npm run test:unit"
+    "test": "npm run lint && npm run format && npm run typecheck && npm run test:unit",
+    "test:unit": "mocha --exit test/**/*.{js,cjs}",
+    "lint": "eslint --ext .js --ext .cjs --max-warnings 0 --format unix .",
+    "lint:fix": "eslint --fix --ext .js --ext .cjs .",
+    "format": "prettier --list-different $PWD/'**/*.{js,cjs}'",
+    "format:fix": "prettier --write $PWD/'**/*.{js,cjs}'",
+    "test:ci": "npm run test:unit",
+    "typecheck": "tsc --noEmit",
+    "update-types": "rm -rf types && tsc --emitDeclarationOnly"
  },
  "author": "Overleaf (https://www.overleaf.com)",
  "license": "AGPL-3.0-only",
-  "devDependencies":{
+  "devDependencies": {
    "chai": "^4.3.6",
    "chai-as-promised": "^7.1.1",
-    "mocha": "^10.2.0"
+    "mocha": "^10.2.0",
+    "typescript": "^5.0.4"
  }
 }
--- a/libraries/stream-utils/tsconfig.json
+++ b/libraries/stream-utils/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.backend.json",
+  "include": [
+    "**/*.js",
+    "**/*.cjs"
+  ]
+}