feat(fonts): warn if local font is in public dir (#13678)

florian-lefebvre · ArmandPhilippot · web-flow · commit 2e528cbe353f · 2025-04-24T15:25:25.000+02:00
Co-authored-by: Armand Philippot &lt;git@armand.philippot.eu&gt;
diff --git a/.changeset/social-bats-kiss.md b/.changeset/social-bats-kiss.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Adds warnings about using local font files in the `publicDir` when the experimental fonts API is enabled.
diff --git a/packages/astro/src/assets/fonts/utils.ts b/packages/astro/src/assets/fonts/utils.ts
@@ -1,6 +1,6 @@
 import { createRequire } from 'node:module';
 import { extname } from 'node:path';
-import { fileURLToPath, pathToFileURL } from 'node:url';
+import { pathToFileURL } from 'node:url';
 import type * as unifont from 'unifont';
 import type { Storage } from 'unstorage';
 import { AstroError, AstroErrorData } from '../../core/errors/index.js';
@@ -248,8 +248,11 @@ function dedupe<const T extends Array<any>>(arr: T): T {
 
 function resolveVariants({
 	variants,
-	root,
-}: { variants: LocalFontFamily['variants']; root: URL }): ResolvedLocalFontFamily['variants'] {
+	resolveEntrypoint: _resolveEntrypoint,
+}: {
+	variants: LocalFontFamily['variants'];
+	resolveEntrypoint: (url: string) => string;
+}): ResolvedLocalFontFamily['variants'] {
 	return variants.map((variant) => ({
 		...variant,
 		weight: variant.weight.toString(),
@@ -258,7 +261,7 @@ function resolveVariants({
 			const url = (isValue ? value : value.url).toString();
 			const tech = isValue ? undefined : value.tech;
 			return {
-				url: fileURLToPath(resolveEntrypoint(root, url)),
+				url: _resolveEntrypoint(url),
 				tech,
 			};
 		}),
@@ -275,17 +278,22 @@ export async function resolveFontFamily({
 	generateNameWithHash,
 	root,
 	resolveMod,
+	resolveLocalEntrypoint,
 }: Omit<ResolveProviderOptions, 'provider'> & {
 	family: FontFamily;
 	generateNameWithHash: (family: FontFamily) => string;
+	resolveLocalEntrypoint: (url: string) => string;
 }): Promise<ResolvedFontFamily> {
 	const nameWithHash = generateNameWithHash(family);
 
 	if (family.provider === LOCAL_PROVIDER_NAME) {
 		return {
 			...family,
 			nameWithHash,
-			variants: resolveVariants({ variants: family.variants, root }),
+			variants: resolveVariants({
+				variants: family.variants,
+				resolveEntrypoint: resolveLocalEntrypoint,
+			}),
 			fallbacks: family.fallbacks ? dedupe(family.fallbacks) : undefined,
 		};
 	}
diff --git a/packages/astro/src/assets/fonts/vite-plugin-fonts.ts b/packages/astro/src/assets/fonts/vite-plugin-fonts.ts
@@ -26,6 +26,7 @@ import type { PreloadData, ResolvedFontFamily } from './types.js';
 import {
 	cache,
 	extractFontType,
+	resolveEntrypoint,
 	resolveFontFamily,
 	sortObjectByKey,
 	withoutQuotes,
@@ -118,18 +119,36 @@ export function fontsPlugin({ settings, sync, logger }: Options): Plugin {
 
 		const families: Array<ResolvedFontFamily> = [];
 
+		const root = settings.config.root;
+		const pathsToWarn = new Set<string>();
+
 		for (const family of settings.config.experimental.fonts!) {
 			families.push(
 				await resolveFontFamily({
 					family,
-					root: settings.config.root,
+					root,
 					resolveMod,
 					generateNameWithHash: (_family) =>
 						`${withoutQuotes(_family.name)}-${h64ToString(JSON.stringify(sortObjectByKey(_family)))}`,
+					resolveLocalEntrypoint: (url) => {
+						const resolvedPath = fileURLToPath(resolveEntrypoint(root, url));
+						if (resolvedPath.startsWith(fileURLToPath(settings.config.publicDir))) {
+							pathsToWarn.add(resolvedPath);
+						}
+						return resolvedPath;
+					},
 				}),
 			);
 		}
 
+		for (const path of [...pathsToWarn]) {
+			// TODO: remove when stabilizing
+			logger.warn(
+				'assets',
+				`Found a local font file ${JSON.stringify(path)} in the \`public/\` folder. To avoid duplicated files in the build output, move this file into \`src/\``,
+			);
+		}
+
 		await loadFonts({
 			base: baseUrl,
 			families,
diff --git a/packages/astro/test/units/assets/fonts/utils.test.js b/packages/astro/test/units/assets/fonts/utils.test.js
@@ -11,6 +11,7 @@ import {
 	isGenericFontFamily,
 	proxyURL,
 	renderFontSrc,
+	resolveEntrypoint,
 	resolveFontFamily,
 	toCSS,
 } from '../../../../dist/assets/fonts/utils.js';
@@ -280,6 +281,7 @@ describe('fonts utils', () => {
 					resolveMod: async () => ({ provider: () => {} }),
 					generateNameWithHash: (family) => `${family.name}-x`,
 					root,
+					resolveLocalEntrypoint: (url) => fileURLToPath(resolveEntrypoint(root, url)),
 				}),
 				{
 					name: 'Custom',
@@ -313,6 +315,7 @@ describe('fonts utils', () => {
 					resolveMod: async () => ({ provider: () => {} }),
 					generateNameWithHash: (family) => `${family.name}-x`,
 					root,
+					resolveLocalEntrypoint: (url) => fileURLToPath(resolveEntrypoint(root, url)),
 				}),
 				{
 					name: 'Custom',
@@ -341,6 +344,7 @@ describe('fonts utils', () => {
 				resolveMod: (id) => import(id),
 				generateNameWithHash: (family) => `${family.name}-x`,
 				root,
+				resolveLocalEntrypoint: (url) => fileURLToPath(resolveEntrypoint(root, url)),
 			});
 			assert.equal(res.name, 'Custom');
 			// Required to make TS happy
@@ -358,6 +362,7 @@ describe('fonts utils', () => {
 				resolveMod: (id) => import(id),
 				generateNameWithHash: (family) => `${family.name}-x`,
 				root,
+				resolveLocalEntrypoint: (url) => fileURLToPath(resolveEntrypoint(root, url)),
 			});
 			assert.equal(res.name, 'Custom');
 			// Required to make TS happy
@@ -379,6 +384,7 @@ describe('fonts utils', () => {
 				resolveMod: async () => ({ provider: () => Object.assign(() => {}, { _name: 'test' }) }),
 				generateNameWithHash: (family) => `${family.name}-x`,
 				root,
+				resolveLocalEntrypoint: (url) => fileURLToPath(resolveEntrypoint(root, url)),
 			});
 			assert.equal(res.name, 'Custom');
 			if (res.provider !== 'local') {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'astro': patch
 +---
++
 +Adds warnings about using local font files in the `publicDir` when the experimental fonts API is enabled.