autogenerateCollections() — astro Function Reference

Source Code

packages/astro/src/content/utils.ts lines 542–627

async function autogenerateCollections({
	config,
	settings,
	fs,
}: {
	config?: ContentConfig;
	settings: AstroSettings;
	fs: typeof fsMod;
}): Promise<ContentConfig | undefined> {
	if (!config) {
		return config;
	}

	if (!settings.config.legacy?.collectionsBackwardsCompat) {
		return config;
	}

	const contentDir = new URL('./content/', settings.config.srcDir);
	const collections: Record<string, CollectionConfig> = config.collections ?? {};

	const contentExts = getContentEntryExts(settings);
	const dataExts = getDataEntryExts(settings);

	const contentPattern = globWithUnderscoresIgnored('', contentExts);
	const dataPattern = globWithUnderscoresIgnored('', dataExts);

	let usesContentLayer = false;
	for (const collectionName of Object.keys(collections)) {
		const collection = collections[collectionName];

		if (collection?.type === CONTENT_LAYER_TYPE || collection?.type === LIVE_CONTENT_TYPE) {
			usesContentLayer = true;
			continue;
		}

		const isDataCollection = collection?.type === 'data';
		const base = new URL(`${collectionName}/`, contentDir);

		collections[collectionName] = {
			...collection,
			type: CONTENT_LAYER_TYPE,
			loader: glob({
				base,
				pattern: isDataCollection ? dataPattern : contentPattern,
				[secretLegacyFlag]: true,
			}) as any,
		};
	}

	if (!usesContentLayer && fs.existsSync(contentDir)) {
		const orphanedCollections = [];
		for (const entry of await fs.promises.readdir(contentDir, { withFileTypes: true })) {
			const collectionName = entry.name;

			if (['_', '.'].includes(collectionName.at(0) ?? '')) {
				continue;
			}

			if (entry.isDirectory() && !(collectionName in collections)) {
				orphanedCollections.push(collectionName);
				const base = new URL(`${collectionName}/`, contentDir);
				collections[collectionName] = {
					type: CONTENT_LAYER_TYPE,
					loader: glob({
						base,
						pattern: contentPattern,
						[secretLegacyFlag]: true,
					}) as any,
				};
			}
		}

		if (orphanedCollections.length > 0) {
			console.warn(
				`
Auto-generating collections for folders in "src/content/" that are not defined as collections.
This is deprecated, so you should define these collections yourself in "src/content.config.ts".
The following collections have been auto-generated: ${orphanedCollections
					.map((name) => colors.green(name))
					.join(', ')}\n`,
			);