Throw error if a user’s project adds MDX or sitemap integrations (#626)

withastro · Sep 1, 2023 · 5dd22b8 · 5dd22b8
1 parent 1eb6262
commit 5dd22b8
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/.changeset/brown-olives-share.md b/.changeset/brown-olives-share.md
@@ -0,0 +1,5 @@
+---
+'@astrojs/starlight': minor
+---
+
+Throw an error for duplicate MDX or sitemap integrations
diff --git a/packages/starlight/index.ts b/packages/starlight/index.ts
@@ -50,6 +50,19 @@ export default function StarlightIntegration(opts: StarlightUserConfig): AstroIn
 				updateConfig(newConfig);
 			},
 
+			'astro:config:done': ({ config }) => {
+				const integrations = config.integrations.map(({ name }) => name);
+				for (const builtin of ['@astrojs/mdx', '@astrojs/sitemap']) {
+					if (integrations.filter((name) => name === builtin).length > 1) {
+						throw new Error(
+							`Found more than one instance of ${builtin}.\n` +
+								`Starlight includes ${builtin} by default.\n` +
+								'Please remove it from your integrations array in astro.config.mjs'
+						);
+					}
+				}
+			},
+
 			'astro:build:done': ({ dir }) => {
 				const targetDir = fileURLToPath(dir);
 				const cwd = dirname(fileURLToPath(import.meta.url));