feat: describe task name

README.md

@@ -132,17 +132,26 @@ Planton produces 2 types of errors:
 
 Produced when Planton is initiated with non-unique task names.
 
-`duplicateTaskName` error property describes the offending task name.
+Additional error properties:
+
+* `duplicateTaskName` describes the offending task name.
 
 #### `InvalidTaskConfigurationNameError`
 
 Produced when Planton is initiated with invalid configuration, e.g. `concurrency` value less than 1.
 
+Additional error properties:
+
+* `taskName`
+
 #### `UnexpectedTaskInstructionsError`
 
 Produced when task scheduler produces a result that is not an array or members of array are not strings.
 
-`unexpectedTaskInstructions` error property describes the offending instructions.
+Additional error properties:
+
+* `taskName`
+* `unexpectedTaskInstructions` describes the offending instructions.
 
 Tip: [Inspect logs](#inspecting-logs) for additional details.
 

src/errors.ts

@@ -17,11 +17,15 @@ export class UnexpectedStateError extends PlantonError {
 }
 
 export class InvalidTaskConfigurationNameError extends UnexpectedStateError {
-  constructor (message: string) {
+  taskName: string;
+
+  constructor (taskName: string, message: string) {
     super(
       message,
       'INVALID_TASK_CONFIGURATION',
     );
+
+    this.taskName = taskName;
   }
 }
 
@@ -39,14 +43,17 @@ export class DuplicateTaskNameError extends UnexpectedStateError {
 }
 
 export class UnexpectedTaskInstructionsError extends UnexpectedStateError {
+  taskName: string;
+
   unexpectedTaskInstructions: any;
 
-  constructor (unexpectedTaskInstructions: any) {
+  constructor (taskName: string, unexpectedTaskInstructions: any) {
     super(
       'Unexpected task instructions.',
       'UNEXPECTED_TASK_INSTRUCTIONS',
     );
 
+    this.taskName = taskName;
     this.unexpectedTaskInstructions = unexpectedTaskInstructions;
   }
 }

src/factories/createPlanton.ts

@@ -113,7 +113,7 @@ const createPlanton = (configuration: PlantonConfiguration): Planton => {
     const concurrency = inputTask.concurrency === undefined ? 1 : inputTask.concurrency;
 
     if (concurrency < 1) {
-      throw new InvalidTaskConfigurationNameError('Task concurrency must be greater than 0.');
+      throw new InvalidTaskConfigurationNameError(inputTask.name, 'Task concurrency must be greater than 0.');
     }
 
     const task: Partial<InternalTask> = {
@@ -166,7 +166,7 @@ const createPlanton = (configuration: PlantonConfiguration): Planton => {
 
           if (!Array.isArray(taskInstructions)) {
             events.emit('error', {
-              error: new UnexpectedTaskInstructionsError(taskInstructions),
+              error: new UnexpectedTaskInstructionsError(task.name, taskInstructions),
               taskName: task.name || '',
             });
 
@@ -180,7 +180,7 @@ const createPlanton = (configuration: PlantonConfiguration): Planton => {
 
           if (taskInstructions.length > limit) {
             events.emit('error', {
-              error: new UnexpectedTaskInstructionsError(taskInstructions),
+              error: new UnexpectedTaskInstructionsError(task.name, taskInstructions),
               taskName: task.name || '',
             });
 
@@ -197,7 +197,7 @@ const createPlanton = (configuration: PlantonConfiguration): Planton => {
           for (const taskInstruction of taskInstructions) {
             if (typeof taskInstruction !== 'string') {
               events.emit('error', {
-                error: new UnexpectedTaskInstructionsError(taskInstructions),
+                error: new UnexpectedTaskInstructionsError(task.name, taskInstructions),
                 taskName: task.name || '',
               });