Use TS references to link monorepo packages (#1277)

* Implement script ensuring validity of TS references

* Update TS configuration

* Add TS config for dev scripts

* Add changeset

* Move *.tsbuildinfo files outside of /dist folder

* Document edge case when running scripts with ts-node

.changeset/tasty-masks-grin.md

@@ -0,0 +1,15 @@
+---
+'@api3/airnode-abi': minor
+'@api3/airnode-adapter': minor
+'@api3/airnode-admin': minor
+'@api3/airnode-deployer': minor
+'@api3/airnode-examples': minor
+'@api3/airnode-node': minor
+'@api3/airnode-ois': minor
+'@api3/airnode-operation': minor
+'@api3/airnode-protocol': minor
+'@api3/airnode-utilities': minor
+'@api3/airnode-validator': minor
+---
+
+Link monorepo packages using project references

README.md

@@ -63,6 +63,11 @@ examples) will work out of the box.
 We heavily recommend using UNIX based systems for development. If you are using Windows, consider
 [WSL](https://docs.microsoft.com/en-us/windows/wsl/install).
 
+We use [TS project references](https://www.typescriptlang.org/docs/handbook/project-references.html) to see
+cross-package errors in real time. However, we use `ts-node` to run our development scripts and it
+[does not support project references](https://github.com/TypeStrong/ts-node/issues/897) at the moment. This means that
+some of the errors are only shown in the IDE or at build time, not when run using `ts-node`.
+
 ## Changelog
 
 We use [changesets](https://github.com/atlassian/changesets) to manage the changelog for us. What that means for

package.json

@@ -53,7 +53,7 @@
     "docker:build:client": "docker build --tag api3/airnode-client:latest --file packages/airnode-node/docker/Dockerfile .",
     "format:check": "yarn prettier:check && yarn terraform:fmt:check",
     "format:write": "yarn prettier:write && yarn terraform:fmt:write",
-    "lint": "yarn run lint:eslint && yarn run lint:solhint && yarn format:check && yarn lint:deps-versions",
+    "lint": "yarn run lint:eslint && yarn run lint:solhint && yarn format:check && yarn lint:deps-versions && yarn ts-node scripts/validate-ts-references.ts",
     "lint:deps-versions": "syncpack list-mismatches",
     "lint:eslint": "eslint . --ext .js,.ts",
     "lint:eslint:fix": "eslint . --ext .js,.ts --fix",
@@ -93,6 +93,7 @@
     "@types/node": "^17.0.18",
     "@typescript-eslint/eslint-plugin": "^5.27.1",
     "@typescript-eslint/parser": "^5.27.1",
+    "comment-json": "^4.2.2",
     "eslint": "^8.17.0",
     "eslint-plugin-functional": "^4.2.1",
     "eslint-plugin-import": "^2.26.0",

packages/airnode-abi/.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /dist
+/build
 
 # Test files
 coverage/

packages/airnode-abi/package.json

@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build": "yarn run clean && yarn run compile",
-    "clean": "rimraf -rf *.tsbuildinfo ./dist *.tgz",
+    "clean": "rimraf -rf *.tsbuildinfo ./dist ./build *.tgz",
     "compile": "tsc --build tsconfig.json",
     "pack": "yarn pack",
     "test": "SILENCE_LOGGER=true jest --coverage",

packages/airnode-abi/src/tsconfig.json

@@ -2,6 +2,7 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "composite": true,
+    "tsBuildInfoFile": "../build/src-tsconfig.tsbuildinfo",
 
     "rootDir": "./",
     "outDir": "../dist"

packages/airnode-abi/test/tsconfig.json

@@ -2,7 +2,9 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": "..",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   "include": ["./**/*.ts", "../src/**/*.test.ts"]

packages/airnode-adapter/.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /dist
+/build
 /.serverless
 /.build
 

packages/airnode-adapter/e2e/tsconfig.json

@@ -3,7 +3,9 @@
   "compilerOptions": {
     "types": ["@nomiclabs/hardhat-waffle", "@nomiclabs/hardhat-ethers", "chai", "mocha", "hardhat"],
     "rootDir": "..",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   // Mocha tests use only the ".ts" (not ".test.ts") extension not to conflict with Jest tests

packages/airnode-adapter/package.json

@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build": "yarn run clean && yarn run compile",
-    "clean": "rimraf -rf *.tsbuildinfo ./dist *.tgz",
+    "clean": "rimraf -rf *.tsbuildinfo ./dist ./build *.tgz",
     "compile": "hardhat compile && tsc --build tsconfig.json",
     "pack": "yarn pack",
     "test": "yarn test:ts && yarn test:hardhat",

packages/airnode-adapter/src/tsconfig.json

@@ -2,10 +2,12 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "composite": true,
+    "tsBuildInfoFile": "../build/src-tsconfig.tsbuildinfo",
 
     "rootDir": "./",
     "outDir": "../dist"
   },
+  "references": [{ "path": "../../airnode-ois/src" }],
   "include": ["./**/*.ts"],
   "exclude": ["./**/*.test.ts"]
 }

packages/airnode-adapter/test/tsconfig.json

@@ -2,7 +2,9 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": "..",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   "include": ["./**/*.ts", "../src/**/*.test.ts"]

packages/airnode-admin/.gitignore

@@ -1,2 +1,3 @@
 /node_modules
 /dist
+/build

packages/airnode-admin/package.json

@@ -12,7 +12,7 @@
   ],
   "scripts": {
     "build": "yarn run clean && yarn run compile",
-    "clean": "rimraf -rf *.tsbuildinfo ./dist *.tgz",
+    "clean": "rimraf -rf *.tsbuildinfo ./dist ./build *.tgz",
     "cli": "ts-node bin/admin.ts",
     "compile": "tsc --build tsconfig.json",
     "pack": "yarn pack",

packages/airnode-admin/src/tsconfig.json

@@ -2,11 +2,18 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "composite": true,
+    "tsBuildInfoFile": "../build/src-tsconfig.tsbuildinfo",
 
     "rootDir": "..",
     "rootDirs": ["./src", "./bin"],
     "outDir": "../dist"
   },
+  "references": [
+    { "path": "../../airnode-abi/src" },
+    { "path": "../../airnode-protocol/src" },
+    { "path": "../../airnode-utilities/src" },
+    { "path": "../../airnode-validator/src" }
+  ],
   "include": ["./**/*.ts", "../bin/**/*.ts", "../package.json"],
   "exclude": ["./**/*.test.ts"]
 }

packages/airnode-admin/test/tsconfig.json

@@ -2,7 +2,9 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": "..",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   "include": ["./**/*.ts", "../src/**/*.test.ts"]

packages/airnode-deployer/.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /dist
+/build
 /.serverless
 /.build
 /.webpack

packages/airnode-deployer/package.json

@@ -12,7 +12,7 @@
   ],
   "scripts": {
     "build": "yarn clean && yarn compile && yarn webpack && yarn copy:webpack && yarn copy:terraform",
-    "clean": "rimraf -rf *.tsbuildinfo ./dist ./.webpack *.tgz",
+    "clean": "rimraf -rf *.tsbuildinfo ./dist ./.webpack ./build *.tgz",
     "cli": "ts-node bin/deployer.ts",
     "compile": "tsc --build tsconfig.json",
     "copy:terraform": "copyfiles terraform/**/**/**/*.tf terraform/**/**/**/*.tpl  dist/",

packages/airnode-deployer/src/tsconfig.json

@@ -2,11 +2,18 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "composite": true,
+    "tsBuildInfoFile": "../build/src-tsconfig.tsbuildinfo",
 
     "rootDir": "..",
     "rootDirs": ["./src", "./bin"],
     "outDir": "../dist"
   },
+  "references": [
+    { "path": "../../airnode-node/src" },
+    { "path": "../../airnode-protocol/src" },
+    { "path": "../../airnode-utilities/src" },
+    { "path": "../../airnode-validator/src" }
+  ],
   "include": ["./**/*.ts", "../bin/**/*.ts", "../package.json"],
   "exclude": ["./**/*.test.ts"]
 }

packages/airnode-deployer/test/tsconfig.json

@@ -2,7 +2,9 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": "..",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   "include": ["./**/*.ts", "../src/**/*.test.ts"]

packages/airnode-examples/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 log.json
 /dist
+/build
 
 # Hardhat files
 /cache

packages/airnode-examples/dev-scripts/tsconfig.json

@@ -2,7 +2,9 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": ".",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   "include": ["./**/*.ts"]

packages/airnode-examples/package.json

@@ -9,7 +9,7 @@
   ],
   "scripts": {
     "build": "yarn run clean && yarn compile",
-    "clean": "rimraf -rf *.tsbuildinfo ./dist *.tgz",
+    "clean": "rimraf -rf *.tsbuildinfo ./dist ./build *.tgz",
     "choose-integration": "ts-node src/scripts/choose-integration.ts",
     "compile": "hardhat compile && tsc --build tsconfig.json",
     "create-airnode-config": "ts-node src/scripts/create-airnode-config.ts",

packages/airnode-examples/src/tsconfig.json

@@ -6,6 +6,14 @@
     "rootDir": "./",
     "outDir": "../dist"
   },
+  "references": [
+    { "path": "../../airnode-abi/src" },
+    { "path": "../../airnode-admin/src" },
+    { "path": "../../airnode-deployer/src" },
+    { "path": "../../airnode-node/src" },
+    { "path": "../../airnode-protocol/src" },
+    { "path": "../../airnode-utilities/src" }
+  ],
   "include": ["./**/*.ts"],
   "exclude": ["./**/*.test.ts"]
 }

packages/airnode-examples/test/tsconfig.json

@@ -2,7 +2,9 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": "..",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   "include": ["./**/*.ts", "../src/**/*.test.ts"]

packages/airnode-node/.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /dist
+/build
 /.serverless
 /.build
 

packages/airnode-node/package.json

@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build": "yarn run clean && yarn run compile",
-    "clean": "rimraf -rf *.tsbuildinfo ./dist *.tgz",
+    "clean": "rimraf -rf *.tsbuildinfo ./dist ./build *.tgz",
     "compile": "tsc --build tsconfig.json",
     "dev:invoke": "ts-node src/cli/validate-config.ts && ts-node src/cli/invoke.ts",
     "dev:testApi": "ts-node src/cli/test-api.ts",

packages/airnode-node/src/tsconfig.json

@@ -2,10 +2,20 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "composite": true,
+    "tsBuildInfoFile": "../build/src-tsconfig.tsbuildinfo",
 
     "rootDir": "..",
     "outDir": "../dist"
   },
+  "references": [
+    { "path": "../../airnode-abi/src" },
+    { "path": "../../airnode-adapter/src" },
+    { "path": "../../airnode-ois/src" },
+    { "path": "../../airnode-protocol/src" },
+    { "path": "../../airnode-utilities/src" },
+    { "path": "../../airnode-validator/src" },
+    { "path": "../../airnode-operation/src" }
+  ],
   "include": ["./**/*.ts", "../package.json"],
   "exclude": ["./**/*.test.ts"]
 }

packages/airnode-node/test/tsconfig.json

@@ -2,7 +2,9 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": "..",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   "include": ["./**/*.ts", "../src/**/*.test.ts"]

packages/airnode-ois/.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /dist
+/build
 /.serverless
 /.build
 

packages/airnode-ois/package.json

@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build": "yarn run clean && yarn run compile",
-    "clean": "rimraf -rf *.tsbuildinfo ./dist *.tgz",
+    "clean": "rimraf -rf *.tsbuildinfo ./dist ./build *.tgz",
     "compile": "tsc --build tsconfig.json",
     "pack": "yarn pack"
   },

packages/airnode-ois/src/tsconfig.json

@@ -6,6 +6,7 @@
     "rootDir": "./",
     "outDir": "../dist"
   },
+  "references": [{ "path": "../../airnode-validator/src" }],
   "include": ["./**/*.ts"],
   "exclude": ["./**/*.test.ts"]
 }

packages/airnode-ois/test/tsconfig.json

@@ -2,7 +2,9 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": "..",
-    "noEmit": true
+    // The output files of this TS config are for development only. See the referenced TS configs
+    // which build the sources into the "dist" folder in the root of the validator project.
+    "outDir": "../build"
   },
   "references": [{ "path": "../src" }],
   "include": ["./**/*.ts", "../src/**/*.test.ts"]

packages/airnode-operation/.gitignore

@@ -1,5 +1,6 @@
 node_modules
 /dist
+/build
 
 # Hardhat files
 cache

packages/airnode-operation/package.json

@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build": "yarn run clean && yarn run compile",
-    "clean": "rimraf -rf *.tsbuildinfo ./dist *.tgz",
+    "clean": "rimraf -rf *.tsbuildinfo ./dist ./build *.tgz",
     "compile": "tsc --build tsconfig.json",
     "compile:watch": "tsc --build tsconfig.json -w",
     "dev:api": "ts-node src/server.ts",

packages/airnode-operation/src/tsconfig.json

@@ -2,10 +2,16 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "composite": true,
+    "tsBuildInfoFile": "../build/src-tsconfig.tsbuildinfo",
 
     "rootDir": "./",
     "outDir": "../dist"
   },
+  "references": [
+    { "path": "../../airnode-abi/src" },
+    { "path": "../../airnode-protocol/src" },
+    { "path": "../../airnode-utilities/src" }
+  ],
   "include": ["./**/*.ts"],
   "exclude": ["./**/*.test.ts"]
 }

packages/airnode-protocol/.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /dist
+/build
 
 /cache
 /artifacts