Merge pull request #612 from BeeeQueue/context

Allow Changing `Context` in `newListr()`

package.json

@@ -36,11 +36,11 @@
     "pre-push": "yarn test"
   },
   "lint-staged": {
-    "./*.{ts,js,tsx,jsx,spec.ts}": [
+    "*.{ts,js,tsx,jsx,spec.ts}": [
       "prettier --loglevel warn --write",
       "eslint --fix"
     ],
-    "./*.{json,md}": [
+    "*.{json,md}": [
       "prettier --loglevel warn --write"
     ]
   },

src/lib/task-wrapper.ts

@@ -38,19 +38,19 @@ export class TaskWrapper<Ctx, Renderer extends ListrRendererFactory> {
   }
 
   /** Create a new subtask with given renderer selection from the parent task. */
-  public newListr (
-    task: ListrTask<Ctx, Renderer> | ListrTask<Ctx, Renderer>[] | ((parent: Omit<this, 'skip' | 'enabled'>) => ListrTask<Ctx, Renderer> | ListrTask<Ctx, Renderer>[]),
-    options?: ListrSubClassOptions<Ctx, Renderer>
-  ): Listr<Ctx, any, any> {
-    let tasks: ListrTask<Ctx, Renderer> | ListrTask<Ctx, Renderer>[]
+  public newListr<NewCtx = Ctx>(
+    task: ListrTask<NewCtx, Renderer> | ListrTask<NewCtx, Renderer>[] | ((parent: Omit<this, 'skip' | 'enabled'>) => ListrTask<NewCtx, Renderer> | ListrTask<NewCtx, Renderer>[]),
+    options?: ListrSubClassOptions<NewCtx, Renderer>
+  ): Listr<NewCtx, any, any> {
+    let tasks: ListrTask<NewCtx, Renderer> | ListrTask<NewCtx, Renderer>[]
 
     if (typeof task === 'function') {
       tasks = task(this)
     } else {
       tasks = task
     }
 
-    return new Listr<Ctx, any, any>(tasks, options)
+    return new Listr<NewCtx, any, any>(tasks, options)
   }
 
   /** Report a error in process for error collection. */

src/listr.ts

@@ -113,7 +113,7 @@ export class Listr<Ctx = ListrContext, Renderer extends ListrRendererValue = Lis
     this.renderer.render()
 
     // create a new context
-    this.ctx = context ?? this.options?.ctx ?? ({} as Ctx)
+    this.ctx = this.options?.ctx ?? context ?? ({} as Ctx)
 
     // check if the items are enabled
     await this.checkAll(this.ctx)

tests/general.e2e-spec.ts

@@ -70,6 +70,44 @@ describe('show output from task', () => {
     expect(ctx.test2).toBe(true)
   })
 
+  it('should be able to inject a different context to subtask', async () => {
+    const tasks = new Listr([
+      {
+        title: 'This task will execute.',
+        task: (_, task): Listr =>
+          task.newListr(
+            [
+              {
+                title: 'This is a subtask.',
+                task: async (ctx): Promise<void> => {
+                  ctx.test = true
+                }
+              },
+
+              {
+                title: 'This is another subtask.',
+                task: async (ctx): Promise<void> => {
+                  expect(ctx.test).toBe(true)
+                }
+              }
+            ],
+            { ctx: {} as Record<'test', boolean> }
+          )
+      },
+      {
+        task: (ctx): void => {
+          ctx.test2 = true
+        }
+      }
+    ])
+
+    const ctx = await tasks.run()
+
+    expect(ctx).toStrictEqual(tasks.ctx)
+    expect(ctx.test).toBe(undefined)
+    expect(ctx.test2).toBe(true)
+  })
+
   // Jest timeout does not work here as cloneObject(ctx) is eating up all cpu
   // cycles, i.e. the stack frame take a long time to complete.
   it('should not take an unreasonable amount of time to clone a large ctx object during error collection', async () => {