Add file generation and flag for content intellisense

.changeset/serious-pumas-run.md

@@ -0,0 +1,5 @@
+---
+'astro': minor
+---
+
+Adds supoprt for content collectioni intellisenes

packages/astro/src/@types/astro.ts

@@ -1,5 +1,3 @@
-import type { OutgoingHttpHeaders } from 'node:http';
-import type { AddressInfo } from 'node:net';
 import type {
 	MarkdownHeading,
 	MarkdownVFile,
@@ -9,6 +7,8 @@ import type {
 	ShikiConfig,
 } from '@astrojs/markdown-remark';
 import type * as babel from '@babel/core';
+import type { OutgoingHttpHeaders } from 'node:http';
+import type { AddressInfo } from 'node:net';
 import type * as rollup from 'rollup';
 import type * as vite from 'vite';
 import type {
@@ -78,7 +78,7 @@ export type {
 	UnresolvedImageTransform,
 } from '../assets/types.js';
 export type { RemotePattern } from '../assets/utils/remotePattern.js';
-export type { SSRManifest, AssetsPrefix } from '../core/app/types.js';
+export type { AssetsPrefix, SSRManifest } from '../core/app/types.js';
 export type {
 	AstroCookieGetOptions,
 	AstroCookieSetOptions,
@@ -2183,6 +2183,16 @@ export interface AstroUserConfig {
 		 * For a complete overview, and to give feedback on this experimental API, see the [Server Islands RFC](https://github.com/withastro/roadmap/pull/963).
 		 */
 		serverIslands?: boolean;
+
+		/**
+		 * @docs
+		 * @name experimental.contentCollectionIntellisense
+		 * @type {boolean}
+		 * @default `false`
+		 * @version 4.14.0
+		 * @description
+		 */
+		contentCollectionIntellisense?: boolean;
 	};
 }
 

packages/astro/src/content/types-generator.ts

@@ -1,8 +1,8 @@
+import glob from 'fast-glob';
+import { bold, cyan } from 'kleur/colors';
 import type fsMod from 'node:fs';
 import * as path from 'node:path';
 import { fileURLToPath, pathToFileURL } from 'node:url';
-import glob from 'fast-glob';
-import { bold, cyan } from 'kleur/colors';
 import { type ViteDevServer, normalizePath } from 'vite';
 import { z } from 'zod';
 import { zodToJsonSchema } from 'zod-to-json-schema';
@@ -13,6 +13,7 @@ import type { Logger } from '../core/logger/core.js';
 import { isRelativePath } from '../core/path.js';
 import { CONTENT_TYPES_FILE, VIRTUAL_MODULE_ID } from './consts.js';
 import {
+	type CollectionConfig,
 	type ContentConfig,
 	type ContentObservable,
 	type ContentPaths,
@@ -391,6 +392,8 @@ async function writeContentFiles({
 			entries: {},
 		};
 	}
+
+	let contentCollectionsMap: CollectionEntryMap = {};
 	for (const collectionKey of Object.keys(collectionEntryMap).sort()) {
 		const collectionConfig = contentConfig?.collections[JSON.parse(collectionKey)];
 		const collection = collectionEntryMap[collectionKey];
@@ -445,6 +448,22 @@ async function writeContentFiles({
 					contentTypesStr += `${entryKey}: {\n	id: ${entryKey};\n  slug: ${slugType};\n  body: string;\n  collection: ${collectionKey};\n  data: ${dataType}\n} & ${renderType};\n`;
 				}
 				contentTypesStr += `};\n`;
+
+				if (
+					collectionConfig?.schema &&
+					settings.config.experimental.contentCollectionIntellisense
+				) {
+					await generateJSONSchema(
+						fs,
+						collectionConfig,
+						collectionKey,
+						collectionSchemasDir,
+						logger,
+					);
+
+					contentCollectionsMap[collectionKey] = collection;
+				}
+
 				break;
 			case 'data':
 				if (collectionEntryKeys.length === 0) {
@@ -458,42 +477,47 @@ async function writeContentFiles({
 				}
 
 				if (collectionConfig?.schema) {
-					let zodSchemaForJson =
-						typeof collectionConfig.schema === 'function'
-							? collectionConfig.schema({ image: () => z.string() })
-							: collectionConfig.schema;
-					if (zodSchemaForJson instanceof z.ZodObject) {
-						zodSchemaForJson = zodSchemaForJson.extend({
-							$schema: z.string().optional(),
-						});
-					}
-					try {
-						await fs.promises.writeFile(
-							new URL(`./${collectionKey.replace(/"/g, '')}.schema.json`, collectionSchemasDir),
-							JSON.stringify(
-								zodToJsonSchema(zodSchemaForJson, {
-									name: collectionKey.replace(/"/g, ''),
-									markdownDescription: true,
-									errorMessages: true,
-									// Fix for https://github.com/StefanTerdell/zod-to-json-schema/issues/110
-									dateStrategy: ['format:date-time', 'format:date', 'integer'],
-								}),
-								null,
-								2,
-							),
-						);
-					} catch (err) {
-						// This should error gracefully and not crash the dev server
-						logger.warn(
-							'content',
-							`An error was encountered while creating the JSON schema for the ${collectionKey} collection. Proceeding without it. Error: ${err}`,
-						);
-					}
+					await generateJSONSchema(
+						fs,
+						collectionConfig,
+						collectionKey,
+						collectionSchemasDir,
+						logger,
+					);
 				}
 				break;
 		}
 	}
 
+	let contentCollectionManifest: {
+		collections: { hasSchema: boolean; name: string }[];
+		entries: Record<string, string>;
+	} = {
+		collections: [],
+		entries: {},
+	};
+	Object.entries(contentCollectionsMap).forEach(([collectionKey, collection]) => {
+		const collectionConfig = contentConfig?.collections[JSON.parse(collectionKey)];
+		const key = JSON.parse(collectionKey);
+
+		contentCollectionManifest.collections.push({
+			hasSchema: Boolean(collectionConfig?.schema),
+			name: key,
+		});
+
+		Object.keys(collection.entries).forEach((entryKey) => {
+			const entryPath = fileURLToPath(
+				new URL(JSON.parse(entryKey), contentPaths.contentDir + `${key}/`),
+			);
+			contentCollectionManifest.entries[entryPath] = key;
+		});
+	});
+
+	await fs.promises.writeFile(
+		new URL('./collections.json', collectionSchemasDir),
+		JSON.stringify(contentCollectionManifest, null, 2),
+	);
+
 	if (!fs.existsSync(settings.dotAstroDir)) {
 		fs.mkdirSync(settings.dotAstroDir, { recursive: true });
 	}
@@ -520,3 +544,43 @@ async function writeContentFiles({
 		typeTemplateContent,
 	);
 }
+
+async function generateJSONSchema(
+	fsMod: typeof import('node:fs'),
+	collectionConfig: CollectionConfig,
+	collectionKey: string,
+	collectionSchemasDir: URL,
+	logger: Logger,
+) {
+	let zodSchemaForJson =
+		typeof collectionConfig.schema === 'function'
+			? collectionConfig.schema({ image: () => z.string() })
+			: collectionConfig.schema;
+	if (zodSchemaForJson instanceof z.ZodObject) {
+		zodSchemaForJson = zodSchemaForJson.extend({
+			$schema: z.string().optional(),
+		});
+	}
+	try {
+		await fsMod.promises.writeFile(
+			new URL(`./${collectionKey.replace(/"/g, '')}.schema.json`, collectionSchemasDir),
+			JSON.stringify(
+				zodToJsonSchema(zodSchemaForJson, {
+					name: collectionKey.replace(/"/g, ''),
+					markdownDescription: true,
+					errorMessages: true,
+					// Fix for https://github.com/StefanTerdell/zod-to-json-schema/issues/110
+					dateStrategy: ['format:date-time', 'format:date', 'integer'],
+				}),
+				null,
+				2,
+			),
+		);
+	} catch (err) {
+		// This should error gracefully and not crash the dev server
+		logger.warn(
+			'content',
+			`An error was encountered while creating the JSON schema for the ${collectionKey} collection. Proceeding without it. Error: ${err}`,
+		);
+	}
+}

packages/astro/src/core/config/schema.ts

@@ -89,6 +89,7 @@ export const ASTRO_CONFIG_DEFAULTS = {
 		clientPrerender: false,
 		globalRoutePriority: false,
 		serverIslands: false,
+		contentCollectionIntellisense: false,
 		env: {
 			validateSecrets: false,
 		},
@@ -538,6 +539,10 @@ export const AstroConfigSchema = z.object({
 				.boolean()
 				.optional()
 				.default(ASTRO_CONFIG_DEFAULTS.experimental.serverIslands),
+			contentCollectionIntellisense: z
+				.boolean()
+				.optional()
+				.default(ASTRO_CONFIG_DEFAULTS.experimental.contentCollectionIntellisense),
 		})
 		.strict(
 			`Invalid or outdated experimental feature.\nCheck for incorrect spelling or outdated Astro version.\nSee https://docs.astro.build/en/reference/configuration-reference/#experimental-flags for a list of all current experiments.`,