Add type checking job to the CI workflow (#1827)

Co-authored-by: Chris Swithinbank <[email protected]>

.github/workflows/ci.yml

@@ -44,6 +44,23 @@ jobs:
       - name: Test packages
         run: pnpm -r test:e2e
 
+  type-check:
+    name: Run type checks
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'pnpm'
+      - run: pnpm i
+      - name: Generate docs types
+        working-directory: docs
+        run: pnpm astro sync
+      - name: Type check packages
+        run: pnpm typecheck
+
   pa11y:
     name: Check for accessibility issues
     runs-on: ubuntu-20.04

package.json

@@ -7,7 +7,8 @@
     "build:examples": "pnpm --no-bail --workspace-concurrency 1 --filter '@example/*' build",
     "size": "size-limit",
     "version": "pnpm changeset version && pnpm i --no-frozen-lockfile",
-    "format": "prettier -w --cache --plugin prettier-plugin-astro ."
+    "format": "prettier -w --cache --plugin prettier-plugin-astro .",
+    "typecheck": "tsc -p tsconfig.typecheck.json"
   },
   "license": "MIT",
   "devDependencies": {
@@ -17,6 +18,7 @@
     "astro": "^4.3.5",
     "prettier": "^3.0.0",
     "prettier-plugin-astro": "^0.13.0",
+    "typescript": "^5.4.5",
     "size-limit": "^8.2.4"
   },
   "packageManager": "[email protected]",

packages/starlight/__tests__/basics/route-data.test.ts

@@ -7,6 +7,7 @@ vi.mock('astro:content', async () =>
 		docs: [
 			['index.mdx', { title: 'Home Page' }],
 			['getting-started.mdx', { title: 'Splash', template: 'splash' }],
+			// @ts-expect-error — Using a slug not present in Starlight docs site
 			['showcase.mdx', { title: 'ToC Disabled', tableOfContents: false }],
 			['environmental-impact.md', { title: 'Explicit update date', lastUpdated: new Date() }],
 		],

packages/starlight/__tests__/basics/starlight-page-route-data-extend.test.ts

@@ -1,4 +1,4 @@
-import { assert, expect, test, vi } from 'vitest';
+import { expect, test, vi } from 'vitest';
 import {
 	generateStarlightPageRouteData,
 	type StarlightPageProps,

packages/starlight/__tests__/edit-url/edit-url.test.ts

@@ -8,6 +8,7 @@ vi.mock('astro:content', async () =>
 			['index.mdx', { title: 'Home Page' }],
 			['getting-started.mdx', { title: 'Getting Started' }],
 			[
+				// @ts-expect-error — Using a slug not present in Starlight docs site
 				'showcase.mdx',
 				{ title: 'Custom edit link', editUrl: 'https://example.com/custom-edit?link' },
 			],

packages/starlight/__tests__/i18n-non-root-single-locale/routing.test.ts

@@ -5,6 +5,7 @@ vi.mock('astro:content', async () =>
 	(await import('../test-utils')).mockedAstroContent({
 		docs: [
 			['fr/index.mdx', { title: 'Accueil' }],
+			// @ts-expect-error — Using a slug not present in Starlight docs site
 			['en/index.mdx', { title: 'Home page' }],
 		],
 	})

packages/starlight/utils/createPathFormatter.ts

@@ -34,6 +34,7 @@ function formatPath(
 	href: string,
 	{ format = 'directory', trailingSlash = 'ignore' }: FormatPathOptions
 ) {
+	// @ts-expect-error — TODO: add support for `preserve` (https://github.com/withastro/starlight/issues/1781)
 	const formatStrategy = formatStrategies[format];
 	const trailingSlashStrategy = trailingSlashStrategies[trailingSlash];
 

packages/starlight/utils/user-config.ts

@@ -256,7 +256,7 @@ export const StarlightConfigSchema = UserConfigSchema.strict().transform(
 		const defaultLocaleConfig = {
 			label: 'English',
 			lang: 'en',
-			dir: 'ltr',
+			dir: 'ltr' as const,
 			locale: undefined,
 			...locales?.root,
 		};

packages/tailwind/vitest.config.ts

@@ -4,11 +4,13 @@ export default defineConfig({
 	test: {
 		coverage: {
 			reportsDirectory: './__coverage__',
-			thresholdAutoUpdate: true,
-			lines: 100,
-			functions: 100,
-			branches: 100,
-			statements: 100,
+			thresholds: {
+				autoUpdate: true,
+				lines: 94,
+				functions: 100,
+				branches: 85,
+				statements: 94,
+			},
 		},
 	},
 });

tsconfig.typecheck.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["**/dist/**", "**/__coverage__/**", "packages/starlight/components.ts"]
+}