feat: support new location for content config (#12475)

* feat: support new location for content config

* Test fixes

* Handle missing dir

* Handle missing content dir

* chore: changes from review

* Revert legacy fixtures

* Clarify changeset

Author: ascorbic

.changeset/thirty-clocks-jump.md

@@ -0,0 +1,7 @@
+---
+'astro': minor
+---
+
+Changes the default content config location from `src/content/config.*` to `src/content.config.*`.
+
+The previous location is still supported, and is required if the `legacy.collections` flag is enabled.

examples/blog/src/content/config.ts examples/blog/src/content.config.tsexamples/blog/src/content/config.ts renamed to examples/blog/src/content.config.ts

@@ -26,12 +26,22 @@ type GlobResult = Record<string, LazyImport>;
 type CollectionToEntryMap = Record<string, GlobResult>;
 type GetEntryImport = (collection: string, lookupId: string) => Promise<LazyImport>;
 
+export function getImporterFilename() {
+	// The 4th line in the stack trace should be the importer filename
+	const stackLine = new Error().stack?.split('\n')?.[3];
+	if (!stackLine) {
+		return null;
+	}
+	// Extract the relative path from the stack line
+	const match = /\/(src\/.*?):\d+:\d+/.exec(stackLine);
+	return match?.[1] ?? null;
+}
+
 export function defineCollection(config: any) {
 	if ('loader' in config) {
 		if (config.type && config.type !== CONTENT_LAYER_TYPE) {
 			throw new AstroUserError(
-				'Collections that use the Content Layer API must have a `loader` defined and no `type` set.',
-				"Check your collection definitions in `src/content/config.*`.'",
+				`Collections that use the Content Layer API must have a \`loader\` defined and no \`type\` set. Check your collection definitions in ${getImporterFilename() ?? 'your content config file'}.`,
 			);
 		}
 		config.type = CONTENT_LAYER_TYPE;

examples/portfolio/src/content/config.ts examples/portfolio/src/content.config.tsexamples/portfolio/src/content/config.ts renamed to examples/portfolio/src/content.config.ts

@@ -24,8 +24,16 @@ export async function attachContentServerListeners({
 	settings,
 }: ContentServerListenerParams) {
 	const contentPaths = getContentPaths(settings.config, fs);
-
-	if (fs.existsSync(contentPaths.contentDir)) {
+	if (!settings.config.legacy?.collections) {
+		const contentGenerator = await createContentTypesGenerator({
+			fs,
+			settings,
+			logger,
+			viteServer,
+			contentConfigObserver: globalContentConfigObserver,
+		});
+		await contentGenerator.init();
+	} else if (fs.existsSync(contentPaths.contentDir)) {
 		logger.debug(
 			'content',
 			`Watching ${cyan(

examples/starlog/src/content/config.ts examples/starlog/src/content.config.tsexamples/starlog/src/content/config.ts renamed to examples/starlog/src/content.config.ts

@@ -86,13 +86,12 @@ export async function createContentTypesGenerator({
 	async function init(): Promise<
 		{ typesGenerated: true } | { typesGenerated: false; reason: 'no-content-dir' }
 	> {
-		if (!fs.existsSync(contentPaths.contentDir)) {
-			return { typesGenerated: false, reason: 'no-content-dir' };
-		}
-
 		events.push({ name: 'add', entry: contentPaths.config.url });
 
 		if (settings.config.legacy.collections) {
+			if (!fs.existsSync(contentPaths.contentDir)) {
+				return { typesGenerated: false, reason: 'no-content-dir' };
+			}
 			const globResult = await glob('**', {
 				cwd: fileURLToPath(contentPaths.contentDir),
 				fs: {

…mples/with-markdoc/src/content/config.ts …mples/with-markdoc/src/content.config.tsexamples/with-markdoc/src/content/config.ts renamed to examples/with-markdoc/src/content.config.ts examples/with-markdoc/src/content/config.ts renamed to examples/with-markdoc/src/content.config.ts

@@ -597,7 +597,7 @@ export async function autogenerateCollections({
 			}) as any,
 		};
 	}
-	if (!usesContentLayer) {
+	if (!usesContentLayer && fs.existsSync(contentDir)) {
 		// If the user hasn't defined any collections using the content layer, we'll try and help out by checking for
 		// any orphaned folders in the content directory and creating collections for them.
 		const orphanedCollections = [];
@@ -623,7 +623,7 @@ export async function autogenerateCollections({
 			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".
+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) => green(name))
 					.join(', ')}\n`,
@@ -715,10 +715,10 @@ export type ContentPaths = {
 };
 
 export function getContentPaths(
-	{ srcDir }: Pick<AstroConfig, 'root' | 'srcDir'>,
+	{ srcDir, legacy }: Pick<AstroConfig, 'root' | 'srcDir' | 'legacy'>,
 	fs: typeof fsMod = fsMod,
 ): ContentPaths {
-	const configStats = search(fs, srcDir);
+	const configStats = search(fs, srcDir, legacy?.collections);
 	const pkgBase = new URL('../../', import.meta.url);
 	return {
 		contentDir: new URL('./content/', srcDir),
@@ -728,10 +728,16 @@ export function getContentPaths(
 		config: configStats,
 	};
 }
-function search(fs: typeof fsMod, srcDir: URL) {
-	const paths = ['config.mjs', 'config.js', 'config.mts', 'config.ts'].map(
-		(p) => new URL(`./content/${p}`, srcDir),
-	);
+function search(fs: typeof fsMod, srcDir: URL, legacy?: boolean) {
+	const paths = [
+		...(legacy
+			? []
+			: ['content.config.mjs', 'content.config.js', 'content.config.mts', 'content.config.ts']),
+		'content/config.mjs',
+		'content/config.js',
+		'content/config.mts',
+		'content/config.ts',
+	].map((p) => new URL(`./${p}`, srcDir));
 	for (const file of paths) {
 		if (fs.existsSync(file)) {
 			return { exists: true, url: file };

packages/astro/src/content/runtime.ts

@@ -1446,7 +1446,8 @@ export const GenerateContentTypesError = {
 	title: 'Failed to generate content types.',
 	message: (errorMessage: string) =>
 		`\`astro sync\` command failed to generate content collection types: ${errorMessage}`,
-	hint: 'This error is often caused by a syntax error inside your content, or your content configuration file. Check your `src/content/config.*` file for typos.',
+	hint: (fileName?: string) =>
+		`This error is often caused by a syntax error inside your content, or your content configuration file. Check your ${fileName ?? 'content config'} file for typos.`,
 } satisfies ErrorData;
 /**
  * @docs
@@ -1458,7 +1459,7 @@ export const GenerateContentTypesError = {
  * @docs
  * @description
  * Astro encountered an unknown error loading your content collections.
- * This can be caused by certain errors inside your `src/content/config.ts` file or some internal errors.
+ * This can be caused by certain errors inside your `src/content.config.ts` file or some internal errors.
  *
  * If you can reliably cause this error to happen, we'd appreciate if you could [open an issue](https://astro.build/issues/)
  */
@@ -1501,7 +1502,7 @@ export const GetEntryDeprecationError = {
  * @description
  * A Markdown or MDX entry does not match its collection schema.
  * Make sure that all required fields are present, and that all fields are of the correct type.
- * You can check against the collection schema in your `src/content/config.*` file.
+ * You can check against the collection schema in your `src/content.config.*` file.
  * See the [Content collections documentation](https://docs.astro.build/en/guides/content-collections/) for more information.
  */
 export const InvalidContentEntryFrontmatterError = {
@@ -1528,7 +1529,7 @@ export const InvalidContentEntryFrontmatterError = {
  * @description
  * A content entry does not match its collection schema.
  * Make sure that all required fields are present, and that all fields are of the correct type.
- * You can check against the collection schema in your `src/content/config.*` file.
+ * You can check against the collection schema in your `src/content.config.*` file.
  * See the [Content collections documentation](https://docs.astro.build/en/guides/content-collections/) for more information.
  */
 export const InvalidContentEntryDataError = {
@@ -1553,7 +1554,7 @@ export const InvalidContentEntryDataError = {
  * @description
  * A content entry does not match its collection schema.
  * Make sure that all required fields are present, and that all fields are of the correct type.
- * You can check against the collection schema in your `src/content/config.*` file.
+ * You can check against the collection schema in your `src/content.config.*` file.
  * See the [Content collections documentation](https://docs.astro.build/en/guides/content-collections/) for more information.
  */
 export const ContentEntryDataError = {