Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for failOnError #1294

Merged
merged 3 commits into from
Jun 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ const NitroDefaults: NitroConfig = {
prerender: {
concurrency: 1,
interval: 0,
failOnError: false,
crawlLinks: false,
ignore: [],
routes: [],
Expand Down
15 changes: 15 additions & 0 deletions src/prerender.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@

// Start prerendering
const generatedRoutes = new Set();
const erroredRoutes = new Set<PrerenderGenerateRoute>();
const skippedRoutes = new Set();
const displayedLengthWarns = new Set();
const canPrerender = (route = "/") => {
Expand Down Expand Up @@ -171,6 +172,7 @@
_route.error = new Error(`[${res.status}] ${res.statusText}`) as any;
_route.error.statusCode = res.status;
_route.error.statusMessage = res.statusText;
erroredRoutes.add(_route);
}

// Write to the file
Expand Down Expand Up @@ -252,6 +254,19 @@
interval: nitro.options.prerender.interval,
});

if (nitro.options.prerender.failOnError && erroredRoutes.size > 0) {
nitro.logger.log("\nErrors prerendering:");
for (const route of erroredRoutes) {
nitro.logger.log(
chalk[route.error.statusCode === 404 ? "yellow" : "red"](
` β”œβ”€ ${route.route} (${route.error.statusCode})`
)
);
}
nitro.logger.log("");
throw new Error("Exiting due to prerender errors.");
}

Check warning on line 268 in src/prerender.ts

View check run for this annotation

Codecov / codecov/patch

src/prerender.ts#L258-L268

Added lines #L258 - L268 were not covered by tests

if (nitro.options.compressPublicAssets) {
await compressPublicAssets(nitro);
}
Expand Down
1 change: 1 addition & 0 deletions src/types/nitro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ export interface NitroOptions extends PresetOptions {
concurrency: number;
interval: number;
crawlLinks: boolean;
failOnError: boolean;
ignore: string[];
routes: string[];
};
Expand Down