feat(fonts): rename component (#13207)

withastro · Feb 10, 2025 · c6bc00f · c6bc00f
1 parent 4899359
commit c6bc00f
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 11 deletions.
diff --git a/packages/astro/client.d.ts b/packages/astro/client.d.ts
@@ -54,7 +54,7 @@ declare module 'astro:assets' {
 		inferRemoteSize: typeof import('./dist/assets/utils/index.js').inferRemoteSize;
 		Image: typeof import('./components/Image.astro').default;
 		Picture: typeof import('./components/Picture.astro').default;
-		Fonts: typeof import('./components/Fonts.astro').default;
+		Font: typeof import('./components/Font.astro').default;
 	};
 
 	type ImgAttributes = import('./dist/type-utils.js').WithRequired<

diff --git a/packages/astro/components/Fonts.astro → packages/astro/components/Font.astro b/packages/astro/components/Fonts.astro → packages/astro/components/Font.astro
diff --git a/packages/astro/src/assets/fonts/README.md b/packages/astro/src/assets/fonts/README.md
@@ -8,4 +8,4 @@ The vite plugin orchestrates the fonts logic:
 - In dev, serves a middleware that dynamically loads and caches fonts data
 - In build, download fonts data (from cache if possible)
 
-The `<Fonts />` component is the only aspect not managed in the vite plugin, since it's exported from `astro:assets`.
+The `<Font />` component is the only aspect not managed in the vite plugin, since it's exported from `astro:assets`.
diff --git a/packages/astro/src/assets/fonts/vite-plugin-fonts.ts b/packages/astro/src/assets/fonts/vite-plugin-fonts.ts
@@ -23,16 +23,14 @@ import { AstroError, AstroErrorData } from '../../core/errors/index.js';
 import type { ModuleLoader } from '../../core/module-loader/loader.js';
 import { createViteLoader } from '../../core/module-loader/vite.js';
 
-// TODO: maybe rename Fonts component to Font
-
 interface Options {
 	settings: AstroSettings;
 	sync: boolean;
 	logger: Logger;
 }
 
 /**
- * Preload data is used for links generation inside the <Fonts /> component
+ * Preload data is used for links generation inside the <Font /> component
  */
 type PreloadData = Array<{
 	/**

diff --git a/packages/astro/src/assets/vite-plugin-assets.ts b/packages/astro/src/assets/vite-plugin-assets.ts
@@ -130,7 +130,7 @@ export default function assets({ settings, sync, logger }: Options): vite.Plugin
 					import { getImage as getImageInternal } from "astro/assets";
 					export { default as Image } from "astro/components/${imageComponentPrefix}Image.astro";
 					export { default as Picture } from "astro/components/${imageComponentPrefix}Picture.astro";
-					export { default as Fonts } from "astro/components/Fonts.astro";
+					export { default as Font } from "astro/components/Font.astro";
 					export { inferRemoteSize } from "astro/assets/utils/inferRemoteSize.js";
 
 					export const imageConfig = ${JSON.stringify({ ...settings.config.image, experimentalResponsiveImages: settings.config.experimental.responsiveImages })};

diff --git a/packages/astro/test/fixtures/fonts/src/pages/index.astro b/packages/astro/test/fixtures/fonts/src/pages/index.astro
@@ -1,5 +1,5 @@
 ---
-import { Fonts } from 'astro:assets'
+import { Font } from 'astro:assets'
 ---
 
-<Fonts family='Roboto' />
+<Font family='Roboto' />
diff --git a/packages/astro/test/fixtures/fonts/src/pages/preload.astro b/packages/astro/test/fixtures/fonts/src/pages/preload.astro
@@ -1,5 +1,5 @@
 ---
-import { Fonts } from 'astro:assets'
+import { Font } from 'astro:assets'
 ---
 
-<Fonts family='Roboto' preload />
+<Font family='Roboto' preload />
diff --git a/packages/astro/test/fonts.test.js b/packages/astro/test/fonts.test.js
@@ -9,7 +9,7 @@ describe('astro:fonts', () => {
 	/** @type {import('./test-utils.js').DevServer} */
 	let devServer;
 
-	describe('<Fonts /> component', () => {
+	describe('<Font /> component', () => {
 		// TODO: remove once fonts are stabilized
 		describe('Fonts are not enabled', () => {
 			before(async () => {