Use Typescript project references, improve functions build/deploy (#575)

* More liberal .gitignores on TS output directories

* Use project references for Typescript projects

* Use /dist dir for Cloud Functions deployment payload

* Disable `next build` typechecking

* Fiddle with GitHub tsc jobs

.github/workflows/check.yml

@@ -48,8 +48,8 @@ jobs:
       - name: Run Typescript checker on web client
         if: ${{ success() || failure() }}
         working-directory: web
-        run: tsc --pretty --project tsconfig.json --noEmit
+        run: tsc -b -v --pretty
       - name: Run Typescript checker on cloud functions
         if: ${{ success() || failure() }}
         working-directory: functions
-        run: tsc --pretty --project tsconfig.json --noEmit
+        run: tsc -b -v --pretty

common/.gitignore

@@ -1,6 +1,5 @@
 # Compiled JavaScript files
-lib/**/*.js
+lib/
-lib/**/*.js.map
 
 # TypeScript v1 declaration files
 typings/
@@ -10,4 +9,4 @@ node_modules/
 
 package-lock.json
 ui-debug.log
-firebase-debug.log
+firebase-debug.log

common/tsconfig.json

@@ -1,6 +1,8 @@
 {
   "compilerOptions": {
     "baseUrl": "../",
+    "composite": true,
+    "module": "commonjs",
     "moduleResolution": "node",
     "noImplicitReturns": true,
     "outDir": "lib",

firebase.json

@@ -1,8 +1,8 @@
 {
   "functions": {
-    "predeploy": "npm --prefix \"$RESOURCE_DIR\" run build",
+    "predeploy": "cd functions && yarn build",
     "runtime": "nodejs16",
-    "source": "functions"
+    "source": "functions/dist"
   },
   "firestore": {
     "rules": "firestore.rules",

functions/.gitignore

@@ -2,9 +2,11 @@
 .env*
 .runtimeconfig.json
 
+# GCP deployment artifact
+dist/
+
 # Compiled JavaScript files
-lib/**/*.js
+lib/
-lib/**/*.js.map
 
 # TypeScript v1 declaration files
 typings/

functions/package.json

@@ -5,7 +5,8 @@
     "firestore": "dev-mantic-markets.appspot.com"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "yarn compile && rm -r dist && mkdir -p dist/functions && cp -R ../common/lib dist/common && cp -R lib/src dist/functions/src && cp ../yarn.lock dist && cp package.json dist",
+    "compile": "tsc -b",
     "watch": "tsc -w",
     "shell": "yarn build && firebase functions:shell",
     "start": "yarn shell",
@@ -18,7 +19,7 @@
     "db:backup-remote": "yarn db:rename-remote-backup-folder && gcloud firestore export gs://$npm_package_config_firestore/firestore_export/",
     "verify": "(cd .. && yarn verify)"
   },
-  "main": "lib/functions/src/index.js",
+  "main": "functions/src/index.js",
   "dependencies": {
     "@amplitude/node": "1.10.0",
     "fetch": "1.1.0",

functions/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
     "baseUrl": "../",
+    "composite": true,
     "module": "commonjs",
     "noImplicitReturns": true,
     "outDir": "lib",
@@ -8,6 +9,11 @@
     "strict": true,
     "target": "es2017"
   },
+  "references": [
+    {
+      "path": "../common"
+    }
+  ],
   "compileOnSave": true,
-  "include": ["src", "../common/**/*.ts"]
+  "include": ["src"]
 }

web/next.config.js

@@ -4,6 +4,9 @@ const API_DOCS_URL = 'https://docs.manifold.markets/api'
 module.exports = {
   staticPageGenerationTimeout: 600, // e.g. stats page
   reactStrictMode: true,
+  typescript: {
+    ignoreBuildErrors: true,
+  },
   experimental: {
     externalDir: true,
     optimizeCss: true,

web/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
     "target": "es5",
+    "composite": true,
     "baseUrl": "../",
     "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,
@@ -16,10 +17,15 @@
     "jsx": "preserve",
     "incremental": true
   },
+  "references": [
+    {
+      "path": "../common"
+    }
+  ],
 
   "watchOptions": {
     "excludeDirectories": [".next"]
   },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "../common/**/*.ts"],
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
   "exclude": ["node_modules"]
 }