michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Warn on empty content collections (#8640)

Browse source 
* Warn on empty content collections

* Update packages/astro/src/core/errors/errors-data.ts

Co-authored-by: Reuben Tier <64310361+TheOtterlord@users.noreply.github.com>

---------

Co-authored-by: Reuben Tier <64310361+TheOtterlord@users.noreply.github.com>
This commit is contained in:
Matthew Phillips 2023-09-23 02:12:36 +08:00 • committed by GitHub
parent 974d5117ab
commit f36c4295be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/spotty-jokes-arrive.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Warn on empty content collections

18
packages/astro/src/content/runtime.ts
View file

@ -1,6 +1,5 @@
import type { MarkdownHeading } from '@astrojs/markdown-remark'; import type { MarkdownHeading } from '@astrojs/markdown-remark';
import { ZodIssueCode, string as zodString } from 'zod'; import { ZodIssueCode, string as zodString } from 'zod';
import type { AstroIntegration } from '../@types/astro.js';
import { AstroError, AstroErrorData } from '../core/errors/index.js'; import { AstroError, AstroErrorData } from '../core/errors/index.js';
import { prependForwardSlash } from '../core/path.js'; import { prependForwardSlash } from '../core/path.js';
import { import {
@ -56,7 +55,9 @@ export function createGetCollection({
} else if (collection in dataCollectionToEntryMap) { } else if (collection in dataCollectionToEntryMap) {
type = 'data'; type = 'data';
} else { } else {
return warnOfEmptyCollection(collection); // eslint-disable-next-line no-console
console.warn(`The collection **${collection}** does not exist or is empty. Ensure a collection directory with this name exists.`);
return;
} }
const lazyImports = Object.values( const lazyImports = Object.values(
type === 'content' type === 'content'
@ -390,16 +391,3 @@ type PropagatedAssetsModule = {
function isPropagatedAssetsModule(module: any): module is PropagatedAssetsModule { function isPropagatedAssetsModule(module: any): module is PropagatedAssetsModule {
return typeof module === 'object' && module != null && '__astroPropagation' in module; return typeof module === 'object' && module != null && '__astroPropagation' in module;
} }
function warnOfEmptyCollection(collection: string): AstroIntegration {
return {
name: 'astro-collection',
hooks: {
'astro:server:start': ({ logger }) => {
logger.warn(
`The collection **${collection}** does not exist or is empty. Ensure a collection directory with this name exists.`
);
},
},
};
}

1
packages/astro/src/core/errors/errors-data.ts
View file

@ -1158,6 +1158,7 @@ export const ContentSchemaContainsSlugError = {
/** /**
* @docs * @docs
* @message A collection queried via `getCollection()` does not exist. * @message A collection queried via `getCollection()` does not exist.
* @deprecated Collections that do not exist no longer result in an error. A warning is omitted instead.
* @description * @description
* When querying a collection, ensure a collection directory with the requested name exists under `src/content/`. * When querying a collection, ensure a collection directory with the requested name exists under `src/content/`.
*/ */