Setup CI for type-checking all test apps

Author: NullVoxPopuli

.github/workflows/ci-build.yml

@@ -34,6 +34,42 @@ jobs:
       - run: pnpm test:ember
         working-directory: test-apps/base-tests
 
+  typecheck:
+    name: '${{ matrix.typescript-scenario }}'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    continue-on-error: true
+    strategy:
+      fail-fast: true
+      matrix:
+        typescript-scenario:
+          - typescript@5.0
+          - typescript@5.1
+          - typescript@5.2
+          - typescript@5.3
+          - typescript@5.4
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: wyvox/action-setup-pnpm@v3
+      - run: pnpm prepack
+        working-directory: ./addon/
+
+      - name: 'Change base tests TS to ${{ matrix.typescript-scenario }}'
+        run: 'pnpm add --save-dev ${{ matrix.typescript-scenario}}'
+        working-directory: ./test-apps/base-tests/
+
+      - name: 'Change ember-concurrency TS to ${{ matrix.typescript-scenario }}'
+        run: 'pnpm add --save-dev ${{ matrix.typescript-scenario}}'
+        working-directory: ./test-apps/ember-concurrency-v2
+
+      - name: 'Change ember-fetch TS to ${{ matrix.typescript-scenario }}'
+        run: 'pnpm add --save-dev ${{ matrix.typescript-scenario}}'
+        working-directory: ./test-apps/ember-fetch-v8
+
+      - run: pnpm --filter "./test-apps/*" exec tsc --noEmit;
+
+
   try-scenarios:
     timeout-minutes: 10
     name: "Try: ${{ matrix.ember-try-scenario }} @ ${{ matrix.app }}"

.gitignore

@@ -26,5 +26,6 @@ package.json.ember-try
 addon/addon/**/*.js
 
 *.d.ts
+!test-apps/**/*.d.ts
 !addon/types/**/*.d.ts
 *.tgz

addon/addon/build-waiter.ts

@@ -35,7 +35,7 @@ class TestWaiterImpl<T extends object | Primitive = Token> implements TestWaiter
     this._register();
 
     if (this.items.has(token)) {
-      throw new Error(`beginAsync called for ${token} but it is already pending.`);
+      throw new Error(`beginAsync called for ${token as string} but it is already pending.`);
     }
 
     let error = new Error();
@@ -112,7 +112,7 @@ class NoopTestWaiter implements TestWaiter {
     return this;
   }
 
-  endAsync(): void {}
+  endAsync(): void { }
 
   waitUntil(): boolean {
     return true;
@@ -122,7 +122,7 @@ class NoopTestWaiter implements TestWaiter {
     return [];
   }
 
-  reset(): void {}
+  reset(): void { }
 }
 
 /**

addon/addon/waiter-manager.ts

@@ -8,7 +8,7 @@ type Indexable = Record<any, unknown>;
 // this ensures that if @ember/test-waiters exists in multiple places in the
 // build output we will still use a single map of waiters (there really should
 // only be one of them, or else `settled` will not work at all)
-const WAITERS: Map<WaiterName, Waiter> = (function () {
+const WAITERS: Map<WaiterName, Waiter> = (function() {
   const HAS_SYMBOL = typeof Symbol !== 'undefined';
 
   let symbolName = 'TEST_WAITERS';
@@ -33,6 +33,7 @@ function getGlobal(): Indexable {
   if (typeof globalThis !== 'undefined') return indexable(globalThis);
   if (typeof self !== 'undefined') return indexable(self);
   if (typeof window !== 'undefined') return indexable(window);
+  // @ts-expect-error cannot find name 'global' -- for old compatibility
   if (typeof global !== 'undefined') return indexable(global);
 
   throw new Error('unable to locate global object');

addon/package.json

@@ -42,10 +42,6 @@
     "@babel/preset-typescript": "^7.15.0",
     "@ember/optional-features": "^2.0.0",
     "@ember/string": "^3.0.1",
-    "@types/ember": "^3.16.5",
-    "@types/ember-test-helpers": "^1.0.10",
-    "@types/ember-testing-helpers": "^0.0.4",
-    "@types/ember__test-helpers": "^2.6.1",
     "@types/qunit": "^2.19.9",
     "@types/rsvp": "^4.0.4",
     "@typescript-eslint/eslint-plugin": "^4.29.2",
@@ -64,7 +60,7 @@
     "ember-load-initializers": "^2.1.2",
     "ember-maybe-import-regenerator-for-testing": "^1.0.0",
     "ember-resolver": "^8.0.2",
-    "ember-source": "~3.26.1",
+    "ember-source": "^5.0.0",
     "ember-source-channel-url": "^3.0.0",
     "ember-try": "^3.0.0",
     "eslint": "^7.32.0",

addon/tsconfig.json

@@ -4,6 +4,9 @@
     "allowJs": true,
     "moduleResolution": "node",
     "allowSyntheticDefaultImports": true,
+    // have to use this, because the current TS setup errors with ember's own types
+    // this will be fixed during v2 addon conversion
+    "skipLibCheck": true,
     "noImplicitAny": true,
     "noImplicitThis": true,
     "alwaysStrict": true,

addon/types/global.d.ts

@@ -0,0 +1,3 @@
+import 'ember-source/types';
+
+

addon/types/index.d.ts

@@ -17,6 +17,15 @@
     "concurrently": "^8.2.1",
     "release-plan": "^0.8.0"
   },
+  "pnpm": {
+    "overrides_notes": {
+      "@glimmer/*": "https://github.com/glimmerjs/glimmer.js/issues/413"
+    },
+    "overrides": {
+      "@glimmer/validator": ">= 0.84.3",
+      "@glimmer/manager": ">= 0.84.3"
+    }
+  },
   "volta": {
     "node": "18.16.0",
     "pnpm": "8.7.6"