feat(ui): allow UI error method to handle listr errors

no issue
- this allows certain places to run multiple listr checks at once and have the ui class handle any resulting errors

Author: acburdine

lib/ui/index.js

@@ -9,6 +9,7 @@ const Promise   = require('bluebird');
 const inquirer  = require('inquirer');
 const isObject  = require('lodash/isObject');
 const stripAnsi = require('strip-ansi');
+const ListrError = require('listr/lib/listr-error');
 const logSymbols = require('log-symbols');
 const isFunction = require('lodash/isFunction');
 
@@ -330,6 +331,32 @@ class UI {
             this.log(`\nTry running ${(chalk.cyan('ghost doctor'))} to check your system for known issues.`);
 
             this.log('\n' + error.help, 'blue');
+        } else if (error instanceof ListrError) {
+            // Listr errors have an array of errors appended to them
+            this.log('One or more errors occurred.', 'red');
+
+            const logOutput = [];
+
+            error.errors.forEach((err, index) => {
+                const verboseOutput = err.toString(true);
+
+                this.log(`\n${index + 1}) ${err.options && err.options.task ? err.options.task : err.type}\n`, 'red', true);
+                this.log(this.verbose ? verboseOutput : err.toString(false), null, true);
+
+                if (err.logToFile && err.logToFile()) {
+                    logOutput.push(stripAnsi(verboseOutput));
+                }
+            });
+
+            this.log(debugInfo, 'yellow');
+
+            if (logOutput.length) {
+                const logLocation = system.writeErrorLog(stripAnsi(`${debugInfo}\n${logOutput.join('\n\n')}`));
+                this.log(`\nAdditional log info available in: ${logLocation}`);
+            }
+
+            this.log(`\nTry running ${(chalk.cyan('ghost doctor'))} to check your system for known issues.`);
+            this.log('\nPlease refer to https://docs.ghost.org/v1/docs/troubleshooting#section-cli-errors for troubleshooting.', 'blue');
         } else if (error instanceof Error) {
             // System errors or regular old errors go here.
             let output = `An error occurred.\n${chalk.yellow('Message:')} '${error.message}'\n\n`;

test/unit/ui/index-spec.js

@@ -504,6 +504,76 @@ describe('Unit: UI', function () {
             });
         });
 
+        describe('handles ListrErrors', function () {
+            const ListrError = require('listr/lib/listr-error');
+            const errors = require('../../../lib/errors');
+
+            it('verbose without log output', function () {
+                const err = new ListrError('Something happened');
+                err.errors = [
+                    new errors.SystemError('Error 1'),
+                    new errors.SystemError({
+                        message: 'Error 2',
+                        task: 'Task 2'
+                    })
+                ];
+
+                const system = {writeErrorLog: sinon.stub()};
+                const ctx = {
+                    verbose: true,
+                    log: sinon.stub(),
+                    _formatDebug: sinon.stub().returns('cherries')
+                };
+
+                ui.error.call(ctx, err, system);
+
+                expect(ctx.log.callCount).to.equal(8);
+                expect(ctx._formatDebug.calledOnce).to.be.true;
+                expect(system.writeErrorLog.called).to.be.false;
+                expect(ctx.log.getCall(0).args[0]).to.match(/One or more errors occurred/);
+                expect(ctx.log.getCall(1).args[0]).to.match(/1\) SystemError/);
+                expect(stripAnsi(ctx.log.getCall(2).args[0])).to.match(/Message: Error 1/);
+                expect(ctx.log.getCall(3).args[0]).to.match(/2\) Task 2/);
+                expect(stripAnsi(ctx.log.getCall(4).args[0])).to.match(/Message: Error 2/);
+                expect(ctx.log.getCall(5).args[0]).to.equal('cherries');
+                expect(stripAnsi(ctx.log.getCall(6).args[0])).to.match(/Try running ghost doctor to check your system for known issues./);
+                expect(ctx.log.getCall(7).args[0]).to.match(/Please refer to https:\/\/docs.ghost.org/);
+            });
+
+            it('non-verbose with log output', function () {
+                const err = new ListrError('Something happened');
+                err.errors = [
+                    new errors.ProcessError({message: 'Error 1'}),
+                    new errors.ProcessError({
+                        message: 'Error 2',
+                        task: 'Task 2'
+                    })
+                ];
+
+                const system = {writeErrorLog: sinon.stub()};
+                const ctx = {
+                    verbose: false,
+                    log: sinon.stub(),
+                    _formatDebug: sinon.stub().returns('cherries')
+                };
+
+                ui.error.call(ctx, err, system);
+
+                expect(ctx.log.callCount).to.equal(9);
+                expect(ctx._formatDebug.calledOnce).to.be.true;
+                expect(system.writeErrorLog.called).to.be.true;
+                expect(ctx.log.getCall(0).args[0]).to.match(/One or more errors occurred/);
+                expect(ctx.log.getCall(1).args[0]).to.match(/1\) ProcessError/);
+                expect(stripAnsi(ctx.log.getCall(2).args[0])).to.match(/Message: Error 1/);
+                expect(ctx.log.getCall(3).args[0]).to.match(/2\) Task 2/);
+                expect(stripAnsi(ctx.log.getCall(4).args[0])).to.match(/Message: Error 2/);
+                expect(ctx.log.getCall(5).args[0]).to.equal('cherries');
+                expect(ctx.log.getCall(6).args[0]).to.match(/Additional log info available in/);
+                expect(stripAnsi(ctx.log.getCall(7).args[0])).to.match(/Try running ghost doctor to check your system for known issues./);
+                expect(ctx.log.getCall(8).args[0]).to.match(/Please refer to https:\/\/docs.ghost.org/);
+            });
+        });
+
         describe('handles generic errors', function () {
             it('verbosly', function (done) {
                 const system = {writeErrorLog: sinon.stub()};