Remove AstroError if content directory is empty (#8382)
Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>
This commit is contained in:
parent
4398e92987
commit
e522a5eb41
7 changed files with 70 additions and 4 deletions
5
.changeset/hungry-dancers-hug.md
Normal file
5
.changeset/hungry-dancers-hug.md
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
---
|
||||||
|
'astro': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Do not throw an error for an empty collection directory.
|
|
@ -13,6 +13,7 @@ import {
|
||||||
type AstroComponentFactory,
|
type AstroComponentFactory,
|
||||||
} from '../runtime/server/index.js';
|
} from '../runtime/server/index.js';
|
||||||
import type { ContentLookupMap } from './utils.js';
|
import type { ContentLookupMap } from './utils.js';
|
||||||
|
import type { AstroIntegration } from '../@types/astro.js';
|
||||||
|
|
||||||
type LazyImport = () => Promise<any>;
|
type LazyImport = () => Promise<any>;
|
||||||
type GlobResult = Record<string, LazyImport>;
|
type GlobResult = Record<string, LazyImport>;
|
||||||
|
@ -55,10 +56,7 @@ export function createGetCollection({
|
||||||
} else if (collection in dataCollectionToEntryMap) {
|
} else if (collection in dataCollectionToEntryMap) {
|
||||||
type = 'data';
|
type = 'data';
|
||||||
} else {
|
} else {
|
||||||
throw new AstroError({
|
return warnOfEmptyCollection(collection)
|
||||||
...AstroErrorData.CollectionDoesNotExistError,
|
|
||||||
message: AstroErrorData.CollectionDoesNotExistError.message(collection),
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
const lazyImports = Object.values(
|
const lazyImports = Object.values(
|
||||||
type === 'content'
|
type === 'content'
|
||||||
|
@ -392,3 +390,16 @@ 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.`
|
||||||
|
);
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
|
@ -244,6 +244,22 @@ describe('Content Collections', () => {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('With empty collections directory', () => {
|
||||||
|
it('Handles the empty directory correclty', async () => {
|
||||||
|
const fixture = await loadFixture({
|
||||||
|
root: './fixtures/content-collections-empty-dir/'
|
||||||
|
});
|
||||||
|
let error;
|
||||||
|
try {
|
||||||
|
await fixture.build();
|
||||||
|
} catch (e) {
|
||||||
|
error = e.message;
|
||||||
|
}
|
||||||
|
expect(error).to.be.undefined;
|
||||||
|
// TODO: try to render a page
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
describe('SSR integration', () => {
|
describe('SSR integration', () => {
|
||||||
let app;
|
let app;
|
||||||
|
|
||||||
|
|
9
packages/astro/test/fixtures/content-collections-empty-dir/package.json
vendored
Normal file
9
packages/astro/test/fixtures/content-collections-empty-dir/package.json
vendored
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
{
|
||||||
|
"name": "@test/content-collections-empty-dir",
|
||||||
|
"version": "0.0.0",
|
||||||
|
"private": true,
|
||||||
|
"type": "module",
|
||||||
|
"dependencies": {
|
||||||
|
"astro": "workspace:*"
|
||||||
|
}
|
||||||
|
}
|
11
packages/astro/test/fixtures/content-collections-empty-dir/src/content/config.ts
vendored
Normal file
11
packages/astro/test/fixtures/content-collections-empty-dir/src/content/config.ts
vendored
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
import { z, defineCollection } from 'astro:content';
|
||||||
|
|
||||||
|
const blog = defineCollection({
|
||||||
|
schema: z.object({
|
||||||
|
title: z.string(),
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
export const collections = {
|
||||||
|
blog,
|
||||||
|
};
|
8
packages/astro/test/fixtures/content-collections-empty-dir/src/pages/index.astro
vendored
Normal file
8
packages/astro/test/fixtures/content-collections-empty-dir/src/pages/index.astro
vendored
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
---
|
||||||
|
import { getCollection } from 'astro:content'
|
||||||
|
|
||||||
|
const blogs = await getCollection("blogs")
|
||||||
|
// console.log(blogs)
|
||||||
|
---
|
||||||
|
|
||||||
|
<p>This should still render</p>
|
6
pnpm-lock.yaml
generated
6
pnpm-lock.yaml
generated
|
@ -2367,6 +2367,12 @@ importers:
|
||||||
specifier: workspace:*
|
specifier: workspace:*
|
||||||
version: link:../../..
|
version: link:../../..
|
||||||
|
|
||||||
|
packages/astro/test/fixtures/content-collections-empty-dir:
|
||||||
|
dependencies:
|
||||||
|
astro:
|
||||||
|
specifier: workspace:*
|
||||||
|
version: link:../../..
|
||||||
|
|
||||||
packages/astro/test/fixtures/content-collections-empty-md-file:
|
packages/astro/test/fixtures/content-collections-empty-md-file:
|
||||||
dependencies:
|
dependencies:
|
||||||
astro:
|
astro:
|
||||||
|
|
Loading…
Add table
Reference in a new issue