Add TypeScript typechecking to snaps-cli

.github/workflows/build-lint-test.yml

@@ -192,7 +192,9 @@ jobs:
   test:
     name: Test
     runs-on: ubuntu-latest
-    needs: prepare
+    needs:
+      - prepare
+      - build
     strategy:
       fail-fast: false
       matrix:
@@ -212,11 +214,16 @@ jobs:
             packages/snaps-execution-environments/dist/browserify
           key: snaps-execution-environments-build-${{ runner.os }}-${{ matrix.node-version }}-${{ github.sha }}
           fail-on-cache-miss: true
+      - name: Restore build files
+        uses: actions/cache@v4
+        with:
+          path: |
+            packages/*/dist
+          key: build-source-${{ runner.os }}-${{ github.sha }}
+          fail-on-cache-miss: true
       - run: yarn --immutable --immutable-cache
       - name: Install Google Chrome
         run: yarn install-chrome
-      - run: yarn workspace @metamask/snaps-sdk run build
-        if: ${{ matrix.package-name == '@metamask/snaps-cli' }}
       - run: yarn workspace ${{ matrix.package-name }} run test
       - name: Get coverage folder
         id: get-coverage-folder
@@ -320,5 +327,5 @@ jobs:
           node-version-file: '.nvmrc'
           cache: yarn
       - run: yarn --immutable
-      - run: yarn workspace @metamask/snaps-sdk run build
+      - run: yarn build:ci
       - run: yarn workspace @metamask/snaps-cli run test

packages/examples/packages/bip32/snap.config.ts

@@ -6,6 +6,9 @@ const config: SnapConfig = {
   server: {
     port: 8001,
   },
+  typescript: {
+    enabled: true,
+  },
   stats: {
     buffer: false,
     builtIns: {

packages/examples/packages/bip32/src/index.ts

@@ -40,14 +40,13 @@ import { getPrivateNode, getPublicKey } from './utils';
 export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
   switch (request.method) {
     case 'getPublicKey':
-      return await getPublicKey(
-        request.params as unknown as GetBip32PublicKeyParams,
-      );
+      return await getPublicKey(request.params as GetBip32PublicKeyParams);
 
     case 'signMessage': {
       const { message, curve, ...params } = request.params as SignMessageParams;
 
       if (!message || typeof message !== 'string') {
+        // eslint-disable-next-line @typescript-eslint/no-throw-literal
         throw new InvalidParamsError(`Invalid signature data: "${message}".`);
       }
 
@@ -75,6 +74,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
       });
 
       if (!approved) {
+        // eslint-disable-next-line @typescript-eslint/no-throw-literal
         throw new UserRejectedRequestError();
       }
 
@@ -100,6 +100,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
     }
 
     default:
+      // eslint-disable-next-line @typescript-eslint/no-throw-literal
       throw new MethodNotFoundError({ method: request.method });
   }
 };

packages/examples/packages/bip32/tsconfig.json

@@ -1,21 +1,8 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "baseUrl": "./",
-    "paths": {
-      "@metamask/*": ["../../../*/src"]
-    }
+    "composite": false,
+    "baseUrl": "./"
   },
-  "include": ["src", "snap.config.ts"],
-  "references": [
-    {
-      "path": "../../../snaps-sdk"
-    },
-    {
-      "path": "../../../snaps-jest"
-    },
-    {
-      "path": "../../../snaps-cli"
-    }
-  ]
+  "include": ["src", "snap.config.ts"]
 }

packages/examples/packages/bip44/snap.config.ts

@@ -6,6 +6,9 @@ const config: SnapConfig = {
   server: {
     port: 8002,
   },
+  typescript: {
+    enabled: true,
+  },
   stats: {
     buffer: false,
     builtIns: {

packages/examples/packages/bip44/src/index.ts

@@ -59,6 +59,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
       });
 
       if (!approved) {
+        // eslint-disable-next-line @typescript-eslint/no-throw-literal
         throw new UserRejectedRequestError();
       }
 
@@ -67,6 +68,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
     }
 
     default:
+      // eslint-disable-next-line @typescript-eslint/no-throw-literal
       throw new MethodNotFoundError({ method: request.method });
   }
 };

packages/examples/packages/bip44/tsconfig.json

@@ -1,21 +1,8 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "baseUrl": "./",
-    "paths": {
-      "@metamask/*": ["../../../*/src"]
-    }
+    "composite": false,
+    "baseUrl": "./"
   },
-  "include": ["src", "snap.config.ts"],
-  "references": [
-    {
-      "path": "../../../snaps-sdk"
-    },
-    {
-      "path": "../../../snaps-jest"
-    },
-    {
-      "path": "../../../snaps-cli"
-    }
-  ]
+  "include": ["src", "snap.config.ts"]
 }

packages/examples/packages/browserify-plugin/src/index.ts

@@ -23,6 +23,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
       return 'Hello from Browserify!';
 
     default: {
+      // eslint-disable-next-line @typescript-eslint/no-throw-literal
       throw new MethodNotFoundError({ method: request.method });
     }
   }

packages/examples/packages/browserify-plugin/tsconfig.json

@@ -3,20 +3,7 @@
   "compilerOptions": {
     "resolveJsonModule": true,
     "baseUrl": "./",
-    "paths": {
-      "@metamask/*": ["../../../*/src"]
-    }
+    "composite": false
   },
-  "include": ["src", "scripts", "babel.config.json"],
-  "references": [
-    {
-      "path": "../../../snaps-sdk"
-    },
-    {
-      "path": "../../../snaps-browserify-plugin"
-    },
-    {
-      "path": "../../../snaps-jest"
-    }
-  ]
+  "include": ["src", "scripts", "babel.config.json"]
 }

packages/examples/packages/browserify/src/index.ts

@@ -25,6 +25,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
       return 'Hello from the MetaMask Snaps CLI using Browserify!';
 
     default: {
+      // eslint-disable-next-line @typescript-eslint/no-throw-literal
       throw new MethodNotFoundError({ method: request.method });
     }
   }

packages/examples/packages/browserify/tsconfig.json

@@ -3,21 +3,7 @@
   "compilerOptions": {
     "resolveJsonModule": true,
     "baseUrl": "./",
-    "paths": {
-      "@metamask/*/node": ["../../../*/src/node"],
-      "@metamask/*": ["../../../*/src"]
-    }
+    "composite": false
   },
-  "include": ["src", "snap.config.ts"],
-  "references": [
-    {
-      "path": "../../../snaps-sdk"
-    },
-    {
-      "path": "../../../snaps-jest"
-    },
-    {
-      "path": "../../../snaps-cli"
-    }
-  ]
+  "include": ["src", "snap.config.ts"]
 }

packages/examples/packages/client-status/snap.config.ts

@@ -6,6 +6,9 @@ const config: SnapConfig = {
   server: {
     port: 8027,
   },
+  typescript: {
+    enabled: true,
+  },
   stats: {
     buffer: false,
   },

packages/examples/packages/client-status/src/index.ts

@@ -23,6 +23,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
     }
 
     default:
+      // eslint-disable-next-line @typescript-eslint/no-throw-literal
       throw new MethodNotFoundError({ method: request.method });
   }
 };

packages/examples/packages/client-status/tsconfig.json

@@ -1,21 +1,8 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "baseUrl": "./",
-    "paths": {
-      "@metamask/*": ["../../../*/src"]
-    }
+    "composite": false,
+    "baseUrl": "./"
   },
-  "include": ["src", "snap.config.ts"],
-  "references": [
-    {
-      "path": "../../../snaps-sdk"
-    },
-    {
-      "path": "../../../snaps-jest"
-    },
-    {
-      "path": "../../../snaps-cli"
-    }
-  ]
+  "include": ["src", "snap.config.ts"]
 }

packages/examples/packages/cronjobs/snap.config.ts

@@ -6,6 +6,9 @@ const config: SnapConfig = {
   server: {
     port: 8004,
   },
+  typescript: {
+    enabled: true,
+  },
   stats: {
     buffer: false,
   },

packages/examples/packages/cronjobs/src/index.test.ts

@@ -22,7 +22,8 @@ describe('onCronjob', () => {
         ]),
       );
 
-      await ui.ok();
+      // TODO(ritave): Fix types in SnapInterface
+      await (ui as any).ok();
 
       const response = await request;
       expect(response).toRespondWith(null);

packages/examples/packages/cronjobs/src/index.ts

@@ -30,6 +30,7 @@ export const onCronjob: OnCronjobHandler = async ({ request }) => {
         },
       });
     default:
+      // eslint-disable-next-line @typescript-eslint/no-throw-literal
       throw new MethodNotFoundError({ method: request.method });
   }
 };

packages/examples/packages/cronjobs/tsconfig.json

@@ -1,21 +1,8 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "baseUrl": "./",
-    "paths": {
-      "@metamask/*": ["../../../*/src"]
-    }
+    "composite": false,
+    "baseUrl": "./"
   },
-  "include": ["src", "snap.config.ts"],
-  "references": [
-    {
-      "path": "../../../snaps-sdk"
-    },
-    {
-      "path": "../../../snaps-jest"
-    },
-    {
-      "path": "../../../snaps-cli"
-    }
-  ]
+  "include": ["src", "snap.config.ts"]
 }

packages/examples/packages/dialogs/snap.config.ts

@@ -6,6 +6,9 @@ const config: SnapConfig = {
   server: {
     port: 8005,
   },
+  typescript: {
+    enabled: true,
+  },
   stats: {
     buffer: false,
   },

packages/examples/packages/dialogs/src/index.tsx

@@ -91,6 +91,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
       });
 
     default:
+      // eslint-disable-next-line @typescript-eslint/no-throw-literal
       throw new MethodNotFoundError({ method: request.method });
   }
 };

packages/examples/packages/dialogs/tsconfig.json

@@ -3,22 +3,7 @@
   "compilerOptions": {
     "baseUrl": "./",
     "jsx": "react-jsxdev",
-    "paths": {
-      "@metamask/*/jsx": ["../../../*/src/jsx"],
-      "@metamask/*/jsx-dev-runtime": ["../../../*/src/jsx"],
-      "@metamask/*": ["../../../*/src"]
-    }
+    "composite": false
   },
-  "include": ["src", "snap.config.ts"],
-  "references": [
-    {
-      "path": "../../../snaps-sdk"
-    },
-    {
-      "path": "../../../snaps-jest"
-    },
-    {
-      "path": "../../../snaps-cli"
-    }
-  ]
+  "include": ["src", "snap.config.ts"]
 }

packages/examples/packages/errors/snap.config.ts

@@ -6,6 +6,9 @@ const config: SnapConfig = {
   server: {
     port: 8006,
   },
+  typescript: {
+    enabled: true,
+  },
 };
 
 export default config;

packages/examples/packages/errors/tsconfig.json

@@ -1,21 +1,8 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "baseUrl": "./",
-    "paths": {
-      "@metamask/*": ["../../../*/src"]
-    }
+    "composite": false,
+    "baseUrl": "./"
   },
-  "include": ["src", "snap.config.ts"],
-  "references": [
-    {
-      "path": "../../../snaps-sdk"
-    },
-    {
-      "path": "../../../snaps-jest"
-    },
-    {
-      "path": "../../../snaps-cli"
-    }
-  ]
+  "include": ["src", "snap.config.ts"]
 }