config-validate.test.js — astro Source File

Source Code

// @ts-check
import * as assert from 'node:assert/strict';
import { describe, it } from 'node:test';
import { stripVTControlCharacters } from 'node:util';
import * as z from 'zod/v4';
import { fontProviders } from '../../../dist/assets/fonts/providers/index.js';
import { LocalFontProvider } from '../../../dist/assets/fonts/providers/local.js';
import { validateConfig as _validateConfig } from '../../../dist/core/config/validate.js';
import { formatConfigErrorMessage } from '../../../dist/core/messages.js';
import { envField } from '../../../dist/env/config.js';

/**
 *
 * @param {any} userConfig
 */
async function validateConfig(userConfig) {
	return _validateConfig(userConfig, process.cwd(), '');
}

describe('Config Validation', () => {
	it('empty user config is valid', async () => {
		assert.doesNotThrow(() => validateConfig({}).catch((err) => err));
	});

	it('Zod errors are returned when invalid config is used', async () => {
		const configError = await validateConfig({ site: 42 }).catch((err) => err);
		assert.equal(configError instanceof z.ZodError, true);
	});

	it('A validation error can be formatted correctly', async () => {
		const configError = await validateConfig({ site: 42 }).catch((err) => err);
		assert.equal(configError instanceof z.ZodError, true);
		const formattedError = stripVTControlCharacters(formatConfigErrorMessage(configError));
		assert.equal(
			formattedError,
			`[config] Astro found issue(s) with your configuration:

! site: Expected type "string", received "number"`,
		);
	});

	it('Multiple validation errors can be formatted correctly', async () => {
		const veryBadConfig = {
			integrations: [42],
			build: { format: 'invalid' },
		};
		const configError = await validateConfig(veryBadConfig).catch((err) => err);
		assert.equal(configError instanceof z.ZodError, true);
		const formattedError = stripVTControlCharacters(formatConfigErrorMessage(configError));
		assert.equal(
			formattedError,
			`[config] Astro found issue(s) with your configuration:

! integrations.0: Expected type "object", received "number"

! build.format: Did not match union.
  > Expected type "file" | "directory" | "preserve"
  > Received "invalid"`,
		);
	});
// ... (571 more lines)