astro/packages/integrations/sitemap/src/index.ts

import type { AstroConfig, AstroIntegration } from 'astro';
import fs from 'node:fs';
const STATUS_CODE_PAGE_REGEXP = /\/[0-9]{3}\/?$/;

type SitemapOptions =
	| {
			/**
			 * All pages are included in your sitemap by default.
			 * With this config option, you can filter included pages by URL.
			 *
			 * The `page` function parameter is the full URL of your rendered page, including your `site` domain.
			 * Return `true` to include a page in your sitemap, and `false` to remove it.
			 *
			 * ```js
			 * filter: (page) => page !== 'http://example.com/secret-page'
			 * ```
			 */
			filter?(page: string): boolean;

			/**
			 * If you have any URL, not rendered by Astro, that you want to include in your sitemap,
			 * this config option will help you to include your array of custom pages in your sitemap.
			 *
			 * ```js
			 * customPages: ['http://example.com/custom-page', 'http://example.com/custom-page2']
			 * ```
			 */
			customPages?: Array<string>;

			/**
			 * If present, we use the `site` config option as the base for all sitemap URLs
			 * Use `canonicalURL` to override this
			 */
			canonicalURL?: string;
	  }
	| undefined;

/** Construct sitemap.xml given a set of URLs */
function generateSitemap(pages: string[]) {
	// TODO: find way to respect <link rel="canonical"> URLs here
	const urls = [...pages].filter((url) => !STATUS_CODE_PAGE_REGEXP.test(url));
	urls.sort((a, b) => a.localeCompare(b, 'en', { numeric: true })); // sort alphabetically so sitemap is same each time
	let sitemap = `<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">`;
	for (const url of urls) {
		sitemap += `<url><loc>${url}</loc></url>`;
	}
	sitemap += `</urlset>\n`;
	return sitemap;
}

export default function createPlugin({
	filter,
	customPages,
	canonicalURL,
}: SitemapOptions = {}): AstroIntegration {
	let config: AstroConfig;
	return {
		name: '@astrojs/sitemap',
		hooks: {
			'astro:config:done': async ({ config: _config }) => {
				config = _config;
			},
			'astro:build:done': async ({ pages, dir }) => {
				let finalSiteUrl: URL;
				if (canonicalURL) {
					finalSiteUrl = new URL(canonicalURL);
					finalSiteUrl.pathname += finalSiteUrl.pathname.endsWith('/') ? '' : '/'; // normalizes the final url since it's provided by user
				} else if (config.site) {
					finalSiteUrl = new URL(config.base, config.site);
				} else {
					console.warn(
						'The Sitemap integration requires either the `site` astro.config option or `canonicalURL` integration option. Skipping.'
					);
					return;
				}
				let pageUrls = pages.map((p) => {
					const path = finalSiteUrl.pathname + p.pathname;
					return new URL(path, finalSiteUrl).href;
				});
				if (filter) {
					pageUrls = pageUrls.filter((page: string) => filter(page));
				}
				if (customPages) {
					pageUrls = [...pageUrls, ...customPages];
				}
				const sitemapContent = generateSitemap(pageUrls);
				fs.writeFileSync(new URL('sitemap.xml', dir), sitemapContent);
			},
		},
	};
}