Merge pull request #129 from breeffy/branch-exit-return-never

fix: return never from exit functions

Author: JasonEtco

src/exit.ts

@@ -23,23 +23,23 @@ export class Exit {
   /**
    * Stop the action with a "success" status
    */
-  public success (message?: string) {
+  public success (message?: string): never {
     if (message) this.logger.success(message)
     process.exit(SuccessCode)
   }
 
   /**
    * Stop the action with a "neutral" status
    */
-  public neutral (message?: string) {
+  public neutral (message?: string): never {
     if (message) this.logger.info(message)
     process.exit(NeutralCode)
   }
 
   /**
    * Stop the action with a "failed" status
    */
-  public failure (message?: string) {
+  public failure (message?: string): never {
     if (message) this.logger.fatal(message)
     process.exit(FailureCode)
   }

tests/index.test.ts

@@ -37,7 +37,7 @@ describe('Toolkit', () => {
 
     it('logs and fails when the function throws an error', async () => {
       const err = new Error('Whoops!')
-      const exitFailure = jest.fn()
+      const exitFailure = jest.fn<never, any>()
 
       await Toolkit.run(async twolkit => {
         twolkit.exit.failure = exitFailure