Merge <link rel="canonical" /> tags, quick fixes (withastro#2153)

mktbsh · Jul 26, 2024 · e3331bc · e3331bc
1 parent 8c85be1
commit e3331bc
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/packages/starlight/__tests__/basics/head.test.ts b/packages/starlight/__tests__/basics/head.test.ts
@@ -11,6 +11,27 @@ describe('createHead', () => {
 		).toEqual([{ tag: 'title', content: 'Override', attrs: {} }]);
 	});
 
+	test('merges two <link rel="canonical" href="" /> tags', () => {
+		expect(
+			createHead(
+				[{ tag: 'link', attrs: { rel: 'canonical', href: "https://example.com" }, }],
+				[{ tag: 'link', attrs: { rel: 'canonical', href: "https://astro.build" }, content: '' }],
+			)
+		).toEqual([{ tag: 'link', attrs: { rel: 'canonical', href: "https://astro.build" }, content: '' }]);
+	});
+
+	test('does not merge same link tags', () => {
+		expect(
+			createHead(
+				[{ tag: 'link', attrs: { rel: 'stylesheet', href: "primary.css" }, content: '' }],
+				[{ tag: 'link', attrs: { rel: 'stylesheet', href: "secondary.css" }, content: '' }],
+			)
+		).toEqual([
+			{ tag: 'link', attrs: { rel: 'stylesheet', href: "primary.css" }, content: '' },
+			{ tag: 'link', attrs: { rel: 'stylesheet', href: "secondary.css" }, content: '' }
+		]);
+	});
+
 	for (const prop of ['name', 'property', 'http-equiv']) {
 		test(`merges two <meta> tags with same ${prop} value`, () => {
 			expect(

diff --git a/packages/starlight/utils/head.ts b/packages/starlight/utils/head.ts
@@ -25,6 +25,8 @@ function hasTag(head: HeadConfig, entry: HeadConfig[number]): boolean {
 			return head.some(({ tag }) => tag === 'title');
 		case 'meta':
 			return hasOneOf(head, entry, ['name', 'property', 'http-equiv']);
+		case 'link':
+			return head.some(({ attrs }) => typeof attrs.rel === 'string' && ['canonical'].includes(attrs.rel))
 		default:
 			return false;
 	}