feat: suggestion

README.md

@@ -32,26 +32,14 @@ Example of config:
 
 ```js
 // doctorenv.config.js
-
-// Using Builder
 module.exports = ({ builder }) => {
   return builder
-    .task('has npm', ({ bash }) => bash`npm --version`)
-    .task('has yarn', ({ bash }) => bash`yarn --version`)
+    .task('check package manager')
+    .subTask('has npm', ({ bash }) => bash`npm --version`)
+    .subTask('has yarn', ({ bash }) => bash`yarn --version`)
+    .task('has env', ({ checkEnv }) => checkEnv('NODE_ENV'))
     .build()
 }
-
-// Raw
-module.exports = () => [
-  {
-    name: 'has npm',
-    task: ({ bash }) => bash`npm --version`,
-  },
-  {
-    name: 'has yarn',
-    task: ({ bash }) => bash`yarn --version`,
-  },
-]
 ```
 
 Run:

examples/builder.config.js

@@ -9,6 +9,7 @@ module.exports = ({ builder }) => {
     .subTask('child 2', ({ delay }) => delay(3000))
     .subTask('child 3', ({ task }) => task.skip('just the child 3'))
     .subTask('child 4', ({ checkEnv }) => checkEnv('XX'))
+    .setSuggestion('Run source ./env.sh')
     .task('delayed for 2s', async ({ delay }) => delay(2000))
     .setConcurrent()
     .build()

src/builder.js

@@ -1,6 +1,7 @@
 export class Builder {
   constructor() {
     this._currentTask = null
+    this._currentSubTask = null
     this._tasks = []
     this._options = {}
   }
@@ -21,8 +22,15 @@ export class Builder {
     return this
   }
 
+  setSuggestion(suggestion) {
+    ;(this._currentSubTask ?? this._currentTask).suggestion = suggestion
+    return this
+  }
+
   subTask(title, task) {
-    this._currentTask?.tasks.push({ title, task })
+    const definition = { title, task }
+    this._currentSubTask = definition
+    this._currentTask?.tasks.push(definition)
     return this
   }
 

src/reader.js

@@ -29,14 +29,19 @@ function mapper(def) {
   return {
     title: def.title,
     task: async (ctx, task) => {
-      if (def.tasks?.length > 0) {
-        return task.newListr(def.tasks.map(mapper), {
-          concurrent: false,
-          rendererOptions: { collapseSubtasks: true },
-        })
-      }
+      try {
+        if (def.tasks?.length > 0) {
+          return task.newListr(def.tasks.map(mapper), {
+            concurrent: false,
+            rendererOptions: { collapseSubtasks: true },
+          })
+        }
 
-      await def.task(buildContext(ctx, task))
+        await def.task(buildContext(ctx, task))
+      } catch (err) {
+        if (def.suggestion) throw Error(`${def.title} - (${def.suggestion})`)
+        throw err
+      }
     },
   }
 }

src/validator.js

@@ -3,6 +3,7 @@ import Joi from 'joi'
 export const taskSchema = Joi.object({
   title: Joi.string().required(),
   task: Joi.function(),
+  suggestion: Joi.string(),
   tasks: Joi.array().items(Joi.link('#task')),
 }).id('task')