astroContentImportPlugin() — astro Function Reference

Source Code

packages/astro/src/content/vite-plugin-content-imports.ts lines 66–232

export function astroContentImportPlugin({
	fs,
	settings,
	logger,
}: {
	fs: typeof fsMod;
	settings: AstroSettings;
	logger: Logger;
}): Plugin[] {
	const contentPaths = getContentPaths(
		settings.config,
		fs,
		settings.config.legacy?.collectionsBackwardsCompat,
	);
	const contentEntryExts = getContentEntryExts(settings);
	const dataEntryExts = getDataEntryExts(settings);

	const contentEntryConfigByExt = getEntryConfigByExtMap(settings.contentEntryTypes);
	const dataEntryConfigByExt = getEntryConfigByExtMap(settings.dataEntryTypes);
	const { contentDir } = contentPaths;
	let shouldEmitFile = false;
	let symlinks: Map<string, string>;
	const plugins: Plugin[] = [
		{
			name: 'astro:content-imports',
			config(_config, env) {
				shouldEmitFile = env.command === 'build';
			},
			async buildStart() {
				// Get symlinks once at build start
				symlinks = await getSymlinkedContentCollections({ contentDir, logger, fs });
			},
			transform: {
				filter: {
					id: new RegExp(`(?:\\?|&)(?:${DATA_FLAG}|${CONTENT_FLAG})(?:&|=|$)`),
				},
				async handler(_, viteId) {
					if (hasContentFlag(viteId, DATA_FLAG)) {
						// By default, Vite will resolve symlinks to their targets. We need to reverse this for
						// content entries, so we can get the path relative to the content directory.
						const fileId = reverseSymlink({
							entry: viteId.split('?')[0] ?? viteId,
							contentDir,
							symlinks,
						});
						// Data collections don't need to rely on the module cache.
						// This cache only exists for the `render()` function specific to content.
						const { id, data, collection, _internal } = await getDataEntryModule({
							fileId,
							entryConfigByExt: dataEntryConfigByExt,
							contentDir,
							config: settings.config,
							fs,
							pluginContext: this,
							shouldEmitFile,
						});

						const code = `
export const id = ${JSON.stringify(id)};
export const collection = ${JSON.stringify(collection)};
export const data = ${stringifyEntryData(data, settings.buildOutput === 'server')};
export const _internal = {
	type: 'data',
	filePath: ${JSON.stringify(_internal.filePath)},
	rawData: ${JSON.stringify(_internal.rawData)},
};
`;
						return code;
					} else if (hasContentFlag(viteId, CONTENT_FLAG)) {
						const fileId = reverseSymlink({ entry: viteId.split('?')[0], contentDir, symlinks });
						const { id, slug, collection, body, data, _internal } = await getContentEntryModule({
							fileId,
							entryConfigByExt: contentEntryConfigByExt,
							contentDir,
							config: settings.config,
							fs,
							pluginContext: this,
							shouldEmitFile,
						});

						const code = `