feat: add error & Command to finally hook options (#1422)

* test: resolve @oclif/core to local

* feat: add error & Command to finally hook options (#1417)

* test: remove resolution

---------

Co-authored-by: Benjamin Levesque <[email protected]>

Author: mdonnalley

src/interfaces/hooks.ts

@@ -27,7 +27,7 @@ export interface Hooks {
     return: unknown
   }
   finally: {
-    options: {argv: string[]; id: string}
+    options: {argv: string[]; id: string; Command: Command.Loadable | undefined; error: Error | undefined}
     return: void
   }
   init: {

src/main.ts

@@ -1,6 +1,7 @@
 import {fileURLToPath, URL} from 'node:url'
 
 import Cache from './cache'
+import {Command} from './command'
 import {Config} from './config'
 import {getHelpFlagAdditions, loadHelpClass, normalizeArgv} from './help'
 import * as Interfaces from './interfaces'
@@ -60,12 +61,12 @@ export async function run(argv?: string[], options?: Interfaces.LoadOptions): Pr
 
   const [id, ...argvSlice] = normalizeArgv(config, argv)
 
-  const runFinally = async () => {
+  const runFinally = async (cmd?: Command.Loadable, error?: Error) => {
     marker?.stop()
     if (!initMarker?.stopped) initMarker?.stop()
     await Performance.collect()
     Performance.debug()
-    await config.runHook('finally', {argv: argvSlice, id})
+    await config.runHook('finally', {argv: argvSlice, Command: cmd, error, id})
   }
 
   // run init hook
@@ -98,9 +99,12 @@ export async function run(argv?: string[], options?: Interfaces.LoadOptions): Pr
 
   initMarker?.stop()
 
+  let err: Error | undefined
   try {
     return await config.runCommand(id, argvSlice, cmd)
+  } catch (error) {
+    err = error as Error
   } finally {
-    await runFinally()
+    await runFinally(cmd, err)
   }
 }

test/config/fixtures/typescript/package.json

@@ -11,6 +11,9 @@
       ],
       "postrun": [
         "./lib/hooks/postrun"
+      ],
+      "finally": [
+        "./lib/hooks/finally"
       ]
     }
   },

test/config/fixtures/typescript/src/hooks/finally.ts

@@ -0,0 +1,6 @@
+export default function finallyHook(options: any): void {
+  console.log('running ts finally hook')
+  if (options.error) {
+    console.log('an error occurred')
+  }
+}

test/config/typescript.test.ts

@@ -14,25 +14,45 @@ describe('typescript', () => {
     })
   })
 
-  it('runs ts command and prerun & postrun hooks', async () => {
+  it('runs ts command and prerun, postrun & finally hooks', async () => {
     const {stdout} = await runCommand(['foo:bar:baz'], root)
-    expect(stdout).to.equal('running ts init hook\nrunning ts prerun hook\nit works!\nrunning ts postrun hook\n')
+    expect(stdout.split('\n')).to.deep.equal([
+      'running ts init hook',
+      'running ts prerun hook',
+      'it works!',
+      'running ts postrun hook',
+      'running ts finally hook',
+      '',
+    ])
   })
 
-  it('runs faulty command, only prerun hook triggers', async () => {
+  it('runs faulty command, only prerun & finally hooks trigger', async () => {
     const {stdout} = await runCommand(['foo:bar:fail'], root)
-    expect(stdout).to.equal('running ts init hook\nrunning ts prerun hook\nit fails!\n')
+    expect(stdout.split('\n')).to.deep.equal([
+      'running ts init hook',
+      'running ts prerun hook',
+      'it fails!',
+      'running ts finally hook',
+      'an error occurred',
+      '',
+    ])
   })
 
-  it('runs ts command, postrun hook captures command result', async () => {
+  it('runs ts command, postrun & finally hooks capture command result', async () => {
     const {stdout} = await runCommand(['foo:bar:test-result'], root)
-    expect(stdout).to.equal(
-      'running ts init hook\nrunning ts prerun hook\nit works!\nrunning ts postrun hook\nreturned success!\n',
-    )
+    expect(stdout.split('\n')).to.deep.equal([
+      'running ts init hook',
+      'running ts prerun hook',
+      'it works!',
+      'running ts postrun hook',
+      'returned success!',
+      'running ts finally hook',
+      '',
+    ])
   })
 
   it('runs init hook', async () => {
     const {stdout} = await runHook('init', {id: 'myid', argv: ['foo']}, {root})
-    expect(stdout).to.equal('running ts init hook\n')
+    expect(stdout.split('\n')).to.deep.equal(['running ts init hook', ''])
   })
 })