feat: add done

README.md

@@ -281,6 +281,22 @@ describe('stdmock tests', () => {
 })
 ```
 
+Done
+----
+
+You can get the mocha `done()` callback by passing in a second argument.
+
+```js
+import {expect, fancy} from 'fancy-test'
+
+describe('calls done', () => {
+  fancy
+  .it('expects FOO=bar', (_, done) => {
+    done()
+  })
+})
+```
+
 Chai
 ----
 

src/base.ts

@@ -19,14 +19,14 @@ const base = <I extends Types.Context>(context: I): Types.Base<I, {}> => {
       arg1 = undefined
     }
     if (!arg1) arg1 = context.expectation || 'test'
-    if (cb) {
-      context.chain = [...context.chain, {
-        run: async (input: any) => {
-          await cb(input)
-        }
-      }]
-    }
-    return context.test(arg1, async function () {
+    async function run(done?: Types.MochaDone) {
+      if (cb) {
+        context.chain = [...context.chain, {
+          run: async (input: any) => {
+            await cb(input, done)
+          }
+        }]
+      }
       for (let i = 0; i < context.chain.length; i++) {
         const handleError = async (err: Error): Promise<boolean> => {
           context.error = err
@@ -52,7 +52,8 @@ const base = <I extends Types.Context>(context: I): Types.Base<I, {}> => {
         if (p.finally) await p.finally(context)
       }
       if (context.error) throw context.error
-    })
+    }
+    return context.test(arg1, (cb && cb.length === 2) ? done => run(done) : () => run())
   }
   return {
     ...Object.entries(context.plugins)

src/types.ts

@@ -25,15 +25,14 @@ export interface PluginDef {
 
 export interface Plugins {[k: string]: PluginDef}
 
+export interface It<I> {
+  (expectation: string, cb?: (context: I, done?: MochaDone) => any): void
+  (cb?: (context: I, done?: MochaDone) => any): void
+}
+
 export type Base<I extends Context, T extends Plugins> = {
-  it: {
-    (expectation: string, cb?: (context: I) => any): void
-    (cb?: (context: I) => any): void
-  }
-  end: {
-    (expectation: string, cb?: (context: I) => any): void
-    (cb?: (context: I) => any): void
-  }
+  it: It<I>
+  end: It<I>
   add<K extends string, O>(key: K, cb: (context: I) => Promise<O> | O): Base<I & {[P in K]: O}, T>
   do<O>(cb: (context: I & O) => any): Base<O & I, T>
   finally(cb: (context: I) => any): Base<I, T>
@@ -45,3 +44,5 @@ export interface EnvOptions {
 }
 
 export interface Env extends Plugin<{envs: (typeof process.env)[]}> {}
+
+export type MochaDone = (error?: any) => any

test/finally.test.ts

@@ -13,5 +13,5 @@ describe('finally', () => {
   fancy
   // not sure how to actually test this
   .finally(() => {})
-  .end('finally')
+  .it('finally')
 })