feat: add postrun hook (#111)

* post run hook

* tested post run hook

* removed package-lock.json

* Added postrun hook test for command failing

* capturing command result in posthook

* Added a test for post-run hook capturing the result of command

* removed useless hooktest script

* Update src/hooks.ts

Co-authored-by: RasPhilCo <[email protected]>

* Added newlines for readability

* Fixed semicolon

Co-authored-by: Max Camp-Oberhauser <[email protected]>
Co-authored-by: RasPhilCo <[email protected]>

src/config.ts

@@ -356,7 +356,8 @@ export class Config implements IConfig {
     }
     const command = c.load()
     await this.runHook('prerun', {Command: command, argv})
-    await command.run(argv, this)
+    const result = await command.run(argv, this)
+    await this.runHook('postrun', {Command: command, result: result, argv})
   }
 
   scopedEnvVar(k: string) {

src/hooks.ts

@@ -10,6 +10,11 @@ export interface Hooks {
     Command: Config.Command.Class;
     argv: string[];
   };
+  postrun: {
+    Command: Config.Command.Class;
+    result?: any;
+    argv: string[];
+  };
   preupdate: {channel: string};
   update: {channel: string};
   'command_not_found': {id: string};
@@ -32,6 +37,7 @@ export namespace Hook {
   export type Init = Hook<Hooks['init']>
   export type PluginsPreinstall = Hook<Hooks['plugins:preinstall']>
   export type Prerun = Hook<Hooks['prerun']>
+  export type Postrun = Hook<Hooks['postrun']>
   export type Preupdate = Hook<Hooks['preupdate']>
   export type Update = Hook<Hooks['update']>
   export type CommandNotFound = Hook<Hooks['command_not_found']>

test/fixtures/typescript/package.json

@@ -8,6 +8,9 @@
       "init": "./lib/hooks/init",
       "prerun": [
         "./lib/hooks/prerun"
+      ],
+      "postrun": [
+        "./lib/hooks/postrun"
       ]
     }
   },

test/fixtures/typescript/src/commands/foo/bar/fail.ts

@@ -0,0 +1,6 @@
+export class Command {
+  static run() {
+    console.log('it fails!')
+    throw new Error('random error')
+  }
+}

test/fixtures/typescript/src/commands/foo/bar/test-result.ts

@@ -0,0 +1,6 @@
+export class Command {
+  static run() {
+    console.log('it works!')
+    return 'returned success!'
+  }
+}

test/fixtures/typescript/src/hooks/postrun.ts

@@ -0,0 +1,6 @@
+export default function postrun(options: any) {
+  console.log('running ts postrun hook')
+  if (options.Command.id === 'foo:bar:test-result') {
+    console.log(options.result)
+  }
+}

test/typescript.test.ts

@@ -20,9 +20,27 @@ describe('typescript', () => {
 
   withConfig
   .stdout()
-  .it('runs ts command and prerun hooks', async ctx => {
+  .it('runs ts command and prerun & postrun hooks', async ctx => {
     await ctx.config.runCommand('foo:bar:baz')
-    expect(ctx.stdout).to.equal('running ts prerun hook\nit works!\n')
+    expect(ctx.stdout).to.equal('running ts prerun hook\nit works!\nrunning ts postrun hook\n')
+  })
+
+  withConfig
+  .stdout()
+  .it('runs faulty command, only prerun hook triggers', async ctx => {
+    try {
+      await ctx.config.runCommand('foo:bar:fail')
+    } catch {
+      console.log('caught error')
+    }
+    expect(ctx.stdout).to.equal('running ts prerun hook\nit fails!\ncaught error\n')
+  })
+
+  withConfig
+  .stdout()
+  .it('runs ts command, postrun hook captures command result', async ctx => {
+    await ctx.config.runCommand('foo:bar:test-result')
+    expect(ctx.stdout).to.equal('running ts prerun hook\nit works!\nrunning ts postrun hook\nreturned success!\n')
   })
 
   withConfig