Update to Vitest 4.1

packages/markdoc/package.json

@@ -19,7 +19,7 @@
   "devDependencies": {
     "@astrojs/markdoc": "^1.0.0",
     "@astrojs/starlight": "workspace:*",
-    "vitest": "^4.1.0-beta.6"
+    "vitest": "^4.1.0"
   },
   "peerDependencies": {
     "@astrojs/markdoc": "^1.0.0",

packages/starlight/__tests__/basics/git.test.ts

@@ -1,4 +1,4 @@
-import { assert, describe, expect, test } from 'vitest';
+import { describe, expect, test, vi } from 'vitest';
 import {
 	getAllNewestCommitDate,
 	getNewestCommitDate,
@@ -119,13 +119,13 @@ describe('getAllNewestCommitDate', () => {
 
 		for (const [file, date] of latestDates.entries()) {
 			const expectedDate = expectedDates.get(file);
-			assert.ok(expectedDate, `Unexpected tracked file: ${file}`);
+			expect.assert(expectedDate, `Unexpected tracked file: ${file}`);
 			expectCommitDateToEqual(new Date(date), expectedDate);
 		}
 
 		for (const file of expectedDates.keys()) {
 			const latestDate = latestDates.get(file);
-			assert.ok(latestDate, `Missing tracked file: ${file}`);
+			expect.assert(latestDate, `Missing tracked file: ${file}`);
 		}
 	});
 
@@ -152,9 +152,11 @@ describe('getAllNewestCommitDate', () => {
 	});
 });
 
-function expectCommitDateToEqual(commitDate: CommitDate, expectedDateStr: ISODate) {
-	const expectedDate = new Date(expectedDateStr);
-	expect(commitDate).toStrictEqual(expectedDate);
-}
+const expectCommitDateToEqual = vi.defineHelper(
+	(commitDate: CommitDate, expectedDateStr: ISODate) => {
+		const expectedDate = new Date(expectedDateStr);
+		expect(commitDate).toStrictEqual(expectedDate);
+	}
+);
 
 type CommitDate = ReturnType<typeof getNewestCommitDate>;

packages/starlight/__tests__/basics/i18n.test.ts

@@ -1,4 +1,4 @@
-import { assert, describe, expect, test, vi } from 'vitest';
+import { describe, expect, test, vi } from 'vitest';
 import config from 'virtual:starlight/user-config';
 import { processI18nConfig, pickLang } from '../../utils/i18n';
 import type { AstroConfig, AstroUserConfig } from 'astro';
@@ -24,7 +24,7 @@ describe('processI18nConfig', () => {
 
 		expect(astroI18nConfig.defaultLocale).toBe('en');
 		expect(astroI18nConfig.locales).toEqual(['en']);
-		assert(typeof astroI18nConfig.routing !== 'string');
+		expect.assert(typeof astroI18nConfig.routing !== 'string');
 		expect(astroI18nConfig.routing?.prefixDefaultLocale).toBe(false);
 
 		// The Starlight configuration should not be modified.

packages/starlight/__tests__/basics/translations.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test, vi } from 'vitest';
+import { beforeAll, describe, expect, test, vi } from 'vitest';
 import { useTranslations } from '../../utils/translations';
 import translations from '../../translations';
 
@@ -10,36 +10,40 @@ describe('useTranslations()', () => {
 	});
 });
 
-describe('t()', async () => {
-	// The mocked user-defined translations are scoped to this `describe` block so that they do not
-	// affect other tests (`vi.mock` → `vi.doMock`).
-	vi.doMock('astro:content', async () =>
-		(await import('../test-utils')).mockedAstroContent({
-			i18n: [
-				[
-					'en',
-					{
-						'test.interpolation': '{{subject}} is {{adjective}}',
-						'test.dataModel': 'Powered by {{integration.name}}',
-						'test.escape': 'The tag is {{tag}}',
-						'test.unescape': 'The tag is {{- tag}}',
-						'test.currency': 'The price is {{price, currency(USD)}}',
-						'test.list': '{{subjects, list}} are awesome',
-						'test.count_one': '{{count}} project',
-						'test.count_other': '{{count}} projects',
-						'test.nesting1': '$t(test.nesting2) is nested',
-						'test.nesting2': 'this UI string',
-					},
+describe('t()', () => {
+	let t: ReturnType<typeof useTranslations>;
+
+	beforeAll(async () => {
+		// The mocked user-defined translations are scoped to this `describe` block so that they do not
+		// affect other tests (`vi.mock` → `vi.doMock`).
+		vi.doMock('astro:content', async () =>
+			(await import('../test-utils')).mockedAstroContent({
+				i18n: [
+					[
+						'en',
+						{
+							'test.interpolation': '{{subject}} is {{adjective}}',
+							'test.dataModel': 'Powered by {{integration.name}}',
+							'test.escape': 'The tag is {{tag}}',
+							'test.unescape': 'The tag is {{- tag}}',
+							'test.currency': 'The price is {{price, currency(USD)}}',
+							'test.list': '{{subjects, list}} are awesome',
+							'test.count_one': '{{count}} project',
+							'test.count_other': '{{count}} projects',
+							'test.nesting1': '$t(test.nesting2) is nested',
+							'test.nesting2': 'this UI string',
+						},
+					],
 				],
-			],
-		})
-	);
-	// Reset the modules registry so that re-importing `../../utils/translations` re-evaluates the
-	// module and re-computes `useTranslations`. Re-importing the module is necessary because
-	// top-level imports cannot be re-evaluated.
-	vi.resetModules();
-	const { useTranslations } = await import('../../utils/translations');
-	const t = useTranslations(undefined);
+			})
+		);
+		// Reset the modules registry so that re-importing `../../utils/translations` re-evaluates the
+		// module and re-computes `useTranslations`. Re-importing the module is necessary because
+		// top-level imports cannot be re-evaluated.
+		vi.resetModules();
+		const { useTranslations } = await import('../../utils/translations');
+		t = useTranslations(undefined);
+	});
 
 	test('supports using interpolation', () => {
 		expect(t).toBeTypeOf('function');
@@ -104,33 +108,41 @@ describe('t()', async () => {
 	});
 });
 
-describe('t.all()', async () => {
-	// See the `t()` tests for an explanation of how the user-defined translations are mocked.
-	vi.doMock('astro:content', async () =>
-		(await import('../test-utils')).mockedAstroContent({
-			i18n: [['en', { 'test.foo': 'bar' }]],
-		})
-	);
-	vi.resetModules();
-	const { useTranslations } = await import('../../utils/translations');
-	const t = useTranslations(undefined);
+describe('t.all()', () => {
+	let t: ReturnType<typeof useTranslations>;
+
+	beforeAll(async () => {
+		// See the `t()` tests for an explanation of how the user-defined translations are mocked.
+		vi.doMock('astro:content', async () =>
+			(await import('../test-utils')).mockedAstroContent({
+				i18n: [['en', { 'test.foo': 'bar' }]],
+			})
+		);
+		vi.resetModules();
+		const { useTranslations } = await import('../../utils/translations');
+		t = useTranslations(undefined);
+	});
 
 	test('returns all translations including custom ones', () => {
 		expect(t.all).toBeTypeOf('function');
 		expect(t.all()).toEqual({ ...translations.en, 'test.foo': 'bar' });
 	});
 });
 
-describe('t.exists()', async () => {
-	// See the `t()` tests for an explanation of how the user-defined translations are mocked.
-	vi.doMock('astro:content', async () =>
-		(await import('../test-utils')).mockedAstroContent({
-			i18n: [['en', { 'test.foo': 'bar' }]],
-		})
-	);
-	vi.resetModules();
-	const { useTranslations } = await import('../../utils/translations');
-	const t = useTranslations(undefined);
+describe('t.exists()', () => {
+	let t: ReturnType<typeof useTranslations>;
+
+	beforeAll(async () => {
+		// See the `t()` tests for an explanation of how the user-defined translations are mocked.
+		vi.doMock('astro:content', async () =>
+			(await import('../test-utils')).mockedAstroContent({
+				i18n: [['en', { 'test.foo': 'bar' }]],
+			})
+		);
+		vi.resetModules();
+		const { useTranslations } = await import('../../utils/translations');
+		t = useTranslations(undefined);
+	});
 
 	test('returns `true` for existing translations', () => {
 		expect(t.exists).toBeTypeOf('function');

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

@@ -1,4 +1,4 @@
-import { assert, describe, expect, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 import type { AstroConfig } from 'astro';
 import config from 'virtual:starlight/user-config';
 import { processI18nConfig } from '../../utils/i18n';
@@ -19,7 +19,7 @@ describe('processI18nConfig', () => {
 			  },
 			]
 		`);
-		assert(typeof astroI18nConfig.routing !== 'string');
+		expect.assert(typeof astroI18nConfig.routing !== 'string');
 		expect(astroI18nConfig.routing?.prefixDefaultLocale).toBe(true);
 
 		// The Starlight configuration should not be modified.

packages/starlight/__tests__/i18n-root-default-locale/i18n.test.ts

@@ -1,4 +1,4 @@
-import { assert, describe, expect, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 import config from 'virtual:starlight/user-config';
 import { processI18nConfig } from '../../utils/i18n';
 
@@ -30,7 +30,7 @@ describe('processI18nConfig', () => {
 			  },
 			]
 		`);
-		assert(typeof astroI18nConfig.routing !== 'string');
+		expect.assert(typeof astroI18nConfig.routing !== 'string');
 		expect(astroI18nConfig.routing?.prefixDefaultLocale).toBe(false);
 
 		// The Starlight configuration should not be modified.

packages/starlight/__tests__/i18n-root-locale/i18n.test.ts

@@ -1,4 +1,4 @@
-import { assert, describe, expect, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 import type { AstroConfig } from 'astro';
 import config from 'virtual:starlight/user-config';
 import { processI18nConfig } from '../../utils/i18n';
@@ -30,7 +30,7 @@ describe('processI18nConfig', () => {
 			  },
 			]
 		`);
-		assert(typeof astroI18nConfig.routing !== 'string');
+		expect.assert(typeof astroI18nConfig.routing !== 'string');
 		expect(astroI18nConfig.routing?.prefixDefaultLocale).toBe(false);
 
 		// The Starlight configuration should not be modified.

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

@@ -1,6 +1,6 @@
 import { getRouteDataTestContext } from '../test-utils';
 import config from 'virtual:starlight/user-config';
-import { assert, expect, test, vi } from 'vitest';
+import { expect, test, vi } from 'vitest';
 import { routes } from '../../utils/routing';
 import { generateRouteData } from '../../utils/routing/data';
 import * as git from 'virtual:starlight/git-info';
@@ -70,7 +70,10 @@ test('fallback routes use their own locale data', () => {
 test('fallback routes use fallback entry last updated dates', () => {
 	const getNewestCommitDate = vi.spyOn(git, 'getNewestCommitDate');
 	const route = routes.find((route) => route.entry.id === routes[4]!.id && route.locale === 'en');
-	assert(route, 'Expected to find English fallback route for `guides/authoring-content.mdx`.');
+	expect.assert(
+		route,
+		'Expected to find English fallback route for `guides/authoring-content.mdx`.'
+	);
 
 	generateRouteData({
 		props: {

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

@@ -1,4 +1,4 @@
-import { assert, describe, expect, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 import config from 'virtual:starlight/user-config';
 import { processI18nConfig } from '../../utils/i18n';
 
@@ -8,7 +8,7 @@ describe('processI18nConfig', () => {
 
 		expect(astroI18nConfig.defaultLocale).toBe('fr-CA');
 		expect(astroI18nConfig.locales).toEqual(['fr-CA']);
-		assert(typeof astroI18nConfig.routing !== 'string');
+		expect.assert(typeof astroI18nConfig.routing !== 'string');
 		expect(astroI18nConfig.routing?.prefixDefaultLocale).toBe(false);
 
 		// The Starlight configuration should not be modified.

packages/starlight/__tests__/i18n/i18n.test.ts

@@ -1,4 +1,4 @@
-import { assert, describe, expect, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 import type { AstroConfig } from 'astro';
 import config from 'virtual:starlight/user-config';
 import { processI18nConfig } from '../../utils/i18n';
@@ -37,7 +37,7 @@ describe('processI18nConfig', () => {
 			  },
 			]
 		`);
-		assert(typeof astroI18nConfig.routing !== 'string');
+		expect.assert(typeof astroI18nConfig.routing !== 'string');
 		expect(astroI18nConfig.routing?.prefixDefaultLocale).toBe(true);
 
 		// The Starlight configuration should not be modified.

packages/starlight/__tests__/middleware/middleware.test.ts

@@ -1,11 +1,11 @@
 import type { APIContext } from 'astro';
-import { expect, test } from 'vitest';
+import { expect, test, vi } from 'vitest';
 import { onRequest } from '../../locals';
 import type { StarlightRouteData } from '../../route-data';
 
 test('starlightRoute throws when accessed outside of a Starlight page', async () => {
 	const context = { locals: {}, currentLocale: 'en' } as APIContext;
-	await onRequest(context, () => Promise.resolve(new Response()));
+	await onRequest(context, vi.fn());
 	expect(() => {
 		// We are testing that accessing `starlightRoute` outside of a Starlight page throws.
 		// eslint-disable-next-line @typescript-eslint/no-unused-expressions
@@ -27,7 +27,7 @@ test('starlightRoute throws when accessed outside of a Starlight page', async ()
 
 test('starlightRoute returns as expected if it has been set', async () => {
 	const context = { locals: {}, currentLocale: 'en' } as APIContext;
-	await onRequest(context, () => Promise.resolve(new Response()));
+	await onRequest(context, vi.fn());
 	context.locals.starlightRoute = { siteTitle: 'Test title' } as StarlightRouteData;
 	expect(context.locals.starlightRoute.siteTitle).toBe('Test title');
 });

packages/starlight/__tests__/plugins/config.test.ts

@@ -61,7 +61,7 @@ describe('validation', () => {
 					[],
 					createTestPluginContext()
 				)
-		).rejects.toThrowError(/Invalid config passed to starlight integration/);
+		).rejects.toThrow(/Invalid config passed to starlight integration/);
 	});
 
 	test('validates plugins configuration before running them', async () => {
@@ -73,7 +73,7 @@ describe('validation', () => {
 					[{ name: 'invalid-plugin' }],
 					createTestPluginContext()
 				)
-		).rejects.toThrowError(/Invalid plugins config passed to starlight integration/);
+		).rejects.toThrow(/Invalid plugins config passed to starlight integration/);
 	});
 
 	test('validates configuration updates from plugins do not update the `plugins` config key', async () => {
@@ -94,7 +94,7 @@ describe('validation', () => {
 					],
 					createTestPluginContext()
 				)
-		).rejects.toThrowError(
+		).rejects.toThrow(
 			/The `test-plugin` plugin tried to update the `plugins` config key which is not supported./
 		);
 	});
@@ -117,7 +117,7 @@ describe('validation', () => {
 					],
 					createTestPluginContext()
 				)
-		).rejects.toThrowError(
+		).rejects.toThrow(
 			/The `test-plugin` plugin tried to update the `routeMiddleware` config key which is not supported./
 		);
 	});
@@ -140,7 +140,7 @@ describe('validation', () => {
 					],
 					createTestPluginContext()
 				)
-		).rejects.toThrowError(/Invalid config update provided by the 'test-plugin' plugin/);
+		).rejects.toThrow(/Invalid config update provided by the 'test-plugin' plugin/);
 	});
 });
 

packages/starlight/__tests__/remark-rehype/asides.test.ts

@@ -130,7 +130,7 @@ Some text
 :::
 		`
 			)
-		).rejects.toThrowError(
+		).rejects.toThrow(
 			// We are not relying on `toThrowErrorMatchingInlineSnapshot()` and our custom snapshot
 			// serializer in this specific test as error thrown in a remark plugin includes a dynamic file
 			// path.

packages/starlight/__tests__/remark-rehype/rehype-file-tree.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from 'vitest';
+import { describe, expect, test, vi } from 'vitest';
 import { processFileTree } from '../../user-components/rehype-file-tree';
 import { Icons, type StarlightIcon } from '../../components-internals/Icons';
 
@@ -176,6 +176,8 @@ function extractFileTree(html: string, stripIcons = true) {
 	return tree;
 }
 
-function expectHtmlToIncludeIcon(html: string, icon: (typeof Icons)[StarlightIcon]) {
-	return expect(extractFileTree(html, false)).toContain(icon.replace('/>', '>'));
-}
+const expectHtmlToIncludeIcon = vi.defineHelper(
+	(html: string, icon: (typeof Icons)[StarlightIcon]) => {
+		return expect(extractFileTree(html, false)).toContain(icon.replace('/>', '>'));
+	}
+);