feat(generate): return non-zero code or page error (fixes #4991) (#5195)

packages/cli/src/commands/generate.js

@@ -33,6 +33,11 @@ export default {
           options.modern = 'client'
         }
       }
+    },
+    'fail-on-error': {
+      type: 'boolean',
+      default: false,
+      description: 'Exit with non-zero status code if there are errors when generating pages'
     }
   },
   async run(cmd) {
@@ -66,9 +71,13 @@ export default {
 
     const generator = await cmd.getGenerator(nuxt)
 
-    await generator.generate({
+    const { errors } = await generator.generate({
       init: true,
       build: cmd.argv.build
     })
+
+    if (cmd.argv['fail-on-error'] && errors.length > 0) {
+      throw new Error('Error generating pages, exiting with non-zero code')
+    }
   }
 }

packages/cli/test/unit/generate.test.js

@@ -113,6 +113,7 @@ describe('generate', () => {
 
     mockGetGenerator(async () => {
       await buildDone()
+      return { errors: [] }
     })
 
     const cmd = NuxtCommand.from(generate, ['generate', '.'])
@@ -134,4 +135,28 @@ describe('generate', () => {
 
     expect(createLock).not.toHaveBeenCalled()
   })
+
+  test('throw an error when fail-on-error enabled and page errors', async () => {
+    mockGetNuxt()
+    mockGetGenerator(() => ({ errors: [{ type: 'dummy' }] }))
+
+    const cmd = NuxtCommand.from(generate, ['generate', '.', '--fail-on-error'])
+    await expect(cmd.run()).rejects
+  })
+
+  test('do not throw an error when fail-on-error disabled and page errors', async () => {
+    mockGetNuxt()
+    mockGetGenerator(() => ({ errors: [{ type: 'dummy' }] }))
+
+    const cmd = NuxtCommand.from(generate, ['generate', '.'])
+    await cmd.run()
+  })
+
+  test('do not throw an error when fail-on-error enabled and no page errors', async () => {
+    mockGetNuxt()
+    mockGetGenerator()
+
+    const cmd = NuxtCommand.from(generate, ['generate', '.', '--fail-on-error'])
+    await cmd.run()
+  })
 })

packages/cli/test/utils/mocking.js

@@ -39,6 +39,8 @@ export const mockGetGenerator = (ret) => {
   const generate = jest.fn()
   if (ret) {
     generate.mockImplementationOnce(ret)
+  } else {
+    generate.mockImplementationOnce(() => ({ errors: [] }))
   }
 
   Command.prototype.getGenerator = jest.fn().mockImplementationOnce(() => ({ generate }))