ci: run type tests against various TypeScript version (#278)

prismicio · Jan 24, 2023 · c11e4ec · c11e4ec
1 parent d94a9e8
commit c11e4ec
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 16 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,21 +1,15 @@
 name: ci
 
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
+on: push
 
 jobs:
-  ci:
+  prepare:
+    name: Prepare (${{ matrix.os}}, Node ${{ matrix.node }})
     runs-on: ${{ matrix.os }}
-
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [14]
+        node: [14, 16, 18]
 
     steps:
       - name: Set up Node
@@ -27,7 +21,8 @@ jobs:
         uses: actions/checkout@master
 
       - name: Cache node_modules
-        uses: actions/cache@v2
+        id: cache
+        uses: actions/cache@v3
         with:
           path: node_modules
           key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/package-lock.json')) }}
@@ -36,12 +31,34 @@ jobs:
         if: steps.cache.outputs.cache-hit != 'true'
         run: npm ci
 
+  suite:
+    needs: prepare
+    name: Suite (${{ matrix.os}}, Node ${{ matrix.node }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        node: [14, 16, 18]
+
+    steps:
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Retrieve node_modules
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/package-lock.json')) }}
+
       - name: Lint
         run: npm run lint
 
-      - name: Types
-        run: npm run types
-
       - name: Unit
         run: npm run unit
 
@@ -52,6 +69,63 @@ jobs:
         if: matrix.os == 'ubuntu-latest' && matrix.node == 14
         uses: codecov/codecov-action@v3
 
+  types:
+    needs: prepare
+    name: Types (${{ matrix.os}}, Node ${{ matrix.node }}, TS ${{ matrix.typescript }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        node: [14]
+        typescript: ['4.5', '4.6', '4.7', '4.8', '4.9']
+
+    steps:
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Retrieve node_modules
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/package-lock.json')) }}
+
+      - name: Overwrite TypeScript
+        run: npm install --no-save typescript@${{ matrix.typescript }} && npx tsc --version
+
+      - name: Types
+        run: npm run types
+
+  size:
+    needs: prepare
+    name: Size (${{ matrix.os}}, Node ${{ matrix.node }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        node: [14]
+
+    steps:
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Retrieve node_modules
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/package-lock.json')) }}
+
       - name: Size
         if: github.event_name == 'pull_request' && matrix.os == 'ubuntu-latest' && matrix.node == 14
         uses: andresz1/size-limit-action@v1

diff --git a/src/helpers/asLink.ts b/src/helpers/asLink.ts
@@ -69,7 +69,8 @@ export const asLink = <
 	const linkField =
 		// prettier-ignore
 		(
-			// @ts-expect-error - Bug in TypeScript 4.9: https://github.com/microsoft/TypeScript/issues/51501
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore - Bug in TypeScript 4.9: https://github.com/microsoft/TypeScript/issues/51501
 			// TODO: Remove the `prettier-ignore` comment when this bug is fixed.
 			"link_type" in linkFieldOrDocument
 				? linkFieldOrDocument

diff --git a/test/__testutils__/testAnyGetMethod.ts b/test/__testutils__/testAnyGetMethod.ts
@@ -65,7 +65,7 @@ export const testAnyGetMethodFactory = (
 				break;
 
 			default:
-				throw new Error("Unknown mode `%o`", mode);
+				throw new Error(`Unknown mode \`${mode}\``);
 		}
 	});
 };