Abort failing Nuxt builds on Netlify

How to prevent broken Nuxt builds from deploying your site on Netlify?

We love fast Nuxt builds on Netlify. But some builds ended up being impossibly fast. Turns out when a Nuxt build produces errors, the Netlify deploy still succeeds. 🤷‍♂️ In other words, broken Nuxt sites end up live in production. So how can we avoid this?

log showing Nuxt build errors
the problem: site is live even though errors occur during Nuxt build

Help failing

Nuxt has no documentation online on how to abort builds with errors. Luckily there is something in the output of nuxt generate --help command:

output of nuxt generate help command
output of nuxt generate help command

Turns out, all we need to do is add a --fail-on-error flag to our build command:

nuxt generate --fail-on-error

That’s it!

Do you want to become a Vue master? During our two day hands-on workshop we’ll teach you everything you need to know to build large performant web apps with Vue. Vue is the SPA framework powering Nuxt, so a better understanding of Vue enables you to build better Nuxt projects.

Join our Vue masterclass

Failing successfully

if (cmd.argv['fail-on-error'] && errors.length > 0) {
  throw new Error('Error generating pages, exiting with non-zero code')

When Netlify receives a "non-zero code" it will fail the deploy:

log showing Nuxt build errors
problem solved: build throws errors and this prevents broken site going live

This is exactly what we want. Because we only want to put our site live when a build is successful.

And naturally this feeds back nicely into our development workflow on GitHub with ❌ and ✅ for failing and succeeding deploys:

GitHub PR commits with status indicators for failing and succeeding deploys
GitHub PR commits with status indicators for failing and succeeding deploys

Failing by default?

There may be scenarios where you want builds with errors to still deploy your site. However we think builds would be more predictable if they would fail on error by default. Maybe Nuxt will solve this in the future. For now, appending nuxt generate with --fail-on-error will fix our Nuxt builds on Netlify.

← All blog posts

Also in love with the web?

For us, that’s about technology and user experience. Fast, available for all, enjoyable to use. And fun to build. This is how our team bands together, adhering to the same values, to make sure we achieve a solid result for clients both large and small. Does that fit you?

Join our team