test-fns 1.0.3 → 1.1.1

package/dist/givenWhenThen.d.ts

@@ -1,3 +1,12 @@
+type TestInputWithReason = [
+    string,
+    {
+        because: string;
+    },
+    () => Promise<unknown> | void
+];
+type TestInputWithoutReason = [string, () => Promise<void> | void];
+type TestInput = TestInputWithReason | TestInputWithoutReason;
 interface Describe {
     (desc: string, fn: () => void): void;
     /** Only runs the tests inside this `describe` for the current file */
@@ -6,11 +15,11 @@ interface Describe {
     skip: (desc: string, fn: () => void) => void;
 }
 interface Test {
-    (desc: string, fn: () => Promise<void> | void): void;
+    (...input: TestInput): void;
     /** Only runs this test for the current file */
-    only: (desc: string, fn: () => Promise<void> | void) => void;
+    only: (...input: TestInput) => void;
     /** Skips running this test */
-    skip: (desc: string, fn: () => Promise<void> | void) => void;
+    skip: (...input: TestInput) => void;
 }
 export declare const given: Describe;
 export declare const when: Describe;

package/dist/givenWhenThen.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.then = exports.when = exports.given = void 0;
+const castToJestTestInput = ({ input, prefix, }) => {
+    if (input.length === 3)
+        return [`${prefix}: ${input[0]}`, input[2]]; // we allow users to specify the reason for code readability, but we dont expose this in the test report to decrease noise. folks can look in the code if they want to know "why"
+    return [`${prefix}: ${input[0]}`, input[1]]; // otherwise, its the normal input
+};
 const given = (desc, fn) => describe(`given: ${desc}`, fn);
 exports.given = given;
 exports.given.only = (desc, fn) => describe.only(`given: ${desc}`, fn);
@@ -9,8 +14,8 @@ const when = (desc, fn) => describe(`when: ${desc}`, fn);
 exports.when = when;
 exports.when.only = (desc, fn) => describe.only(`when: ${desc}`, fn);
 exports.when.skip = (desc, fn) => describe.skip(`when: ${desc}`, fn);
-const then = (desc, fn) => test(`then: ${desc}`, fn);
+const then = (...input) => test(...castToJestTestInput({ input, prefix: 'then' }));
 exports.then = then;
-exports.then.only = (desc, fn) => test.only(`then: ${desc}`, fn);
-exports.then.skip = (desc, fn) => test.skip(`then: ${desc}`, fn);
+exports.then.only = (...input) => test.only(...castToJestTestInput({ input, prefix: 'then' }));
+exports.then.skip = (...input) => test.skip(...castToJestTestInput({ input, prefix: 'then' }));
 //# sourceMappingURL=givenWhenThen.js.map

package/dist/givenWhenThen.js.map

@@ -1 +1 @@
-{"version":3,"file":"givenWhenThen.js","sourceRoot":"","sources":["../src/givenWhenThen.ts"],"names":[],"mappings":";;;AAmBO,MAAM,KAAK,GAAa,CAC7B,IAAY,EACZ,EAA8B,EACxB,EAAE,CAAC,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AAH7B,QAAA,KAAK,SAGwB;AAC1C,aAAK,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAc,EAAQ,EAAE,CAClD,QAAQ,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AACtC,aAAK,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAc,EAAQ,EAAE,CAClD,QAAQ,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AAE/B,MAAM,IAAI,GAAa,CAC5B,IAAY,EACZ,EAA8B,EACxB,EAAE,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AAH5B,QAAA,IAAI,QAGwB;AACzC,YAAI,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAc,EAAQ,EAAE,CACjD,QAAQ,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AACrC,YAAI,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAc,EAAQ,EAAE,CACjD,QAAQ,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AAE9B,MAAM,IAAI,GAAS,CACxB,IAAY,EACZ,EAA8B,EACxB,EAAE,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAS,CAAC,CAAC;AAH/B,QAAA,IAAI,QAG2B;AAC5C,YAAI,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAA8B,EAAQ,EAAE,CACjE,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAS,CAAC,CAAC;AACxC,YAAI,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAA8B,EAAQ,EAAE,CACjE,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAS,CAAC,CAAC"}
+{"version":3,"file":"givenWhenThen.js","sourceRoot":"","sources":["../src/givenWhenThen.ts"],"names":[],"mappings":";;;AAOA,MAAM,mBAAmB,GAAG,CAAC,EAC3B,KAAK,EACL,MAAM,GAIP,EAA4D,EAAE;IAC7D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,GAAG,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iLAAiL;IACtP,OAAO,CAAC,GAAG,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,kCAAkC;AACjF,CAAC,CAAC;AAqBK,MAAM,KAAK,GAAa,CAC7B,IAAY,EACZ,EAA8B,EACxB,EAAE,CAAC,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AAH7B,QAAA,KAAK,SAGwB;AAC1C,aAAK,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAc,EAAQ,EAAE,CAClD,QAAQ,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AACtC,aAAK,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAc,EAAQ,EAAE,CAClD,QAAQ,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AAE/B,MAAM,IAAI,GAAa,CAC5B,IAAY,EACZ,EAA8B,EACxB,EAAE,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AAH5B,QAAA,IAAI,QAGwB;AACzC,YAAI,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAc,EAAQ,EAAE,CACjD,QAAQ,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AACrC,YAAI,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAc,EAAQ,EAAE,CACjD,QAAQ,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AAE9B,MAAM,IAAI,GAAS,CAAC,GAAG,KAAgB,EAAQ,EAAE,CACtD,IAAI,CAAC,GAAG,mBAAmB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;AAD7C,QAAA,IAAI,QACyC;AAC1D,YAAI,CAAC,IAAI,GAAG,CAAC,GAAG,KAAgB,EAAQ,EAAE,CACxC,IAAI,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;AAC/D,YAAI,CAAC,IAAI,GAAG,CAAC,GAAG,KAAgB,EAAQ,EAAE,CACxC,IAAI,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC"}

package/dist/givenWhenThen.test.js

@@ -16,6 +16,15 @@ describe('doesPlantNeedWater', () => {
                 throw new Error('should have been skipped');
             });
         });
+        (0, givenWhenThen_1.when)('the plant has enough water', () => {
+            const plant = {
+                id: 7,
+                hydration: 'WET',
+            };
+            (0, givenWhenThen_1.then)('it should return false', { because: 'because it has enough water' }, () => {
+                expect(doesPlantNeedWater(plant)).toEqual(false);
+            });
+        });
     });
 });
 //# sourceMappingURL=givenWhenThen.test.js.map

package/dist/givenWhenThen.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"givenWhenThen.test.js","sourceRoot":"","sources":["../src/givenWhenThen.test.ts"],"names":[],"mappings":";;AAAA,mDAAoD;AAGpD,MAAM,kBAAkB,GAAG,CAAC,KAAY,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC;AAEvE,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAA,qBAAK,EAAC,SAAS,EAAE,GAAG,EAAE;QACpB,IAAA,oBAAI,EAAC,oCAAoC,EAAE,GAAG,EAAE;YAC9C,MAAM,KAAK,GAAU;gBACnB,EAAE,EAAE,CAAC;gBACL,SAAS,EAAE,KAAK;aACjB,CAAC;YACF,IAAA,oBAAI,EAAC,uBAAuB,EAAE,GAAG,EAAE;gBACjC,MAAM,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YACH,oBAAI,CAAC,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;gBACzD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"givenWhenThen.test.js","sourceRoot":"","sources":["../src/givenWhenThen.test.ts"],"names":[],"mappings":";;AAAA,mDAAoD;AAGpD,MAAM,kBAAkB,GAAG,CAAC,KAAY,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC;AAEvE,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAA,qBAAK,EAAC,SAAS,EAAE,GAAG,EAAE;QACpB,IAAA,oBAAI,EAAC,oCAAoC,EAAE,GAAG,EAAE;YAC9C,MAAM,KAAK,GAAU;gBACnB,EAAE,EAAE,CAAC;gBACL,SAAS,EAAE,KAAK;aACjB,CAAC;YACF,IAAA,oBAAI,EAAC,uBAAuB,EAAE,GAAG,EAAE;gBACjC,MAAM,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YACH,oBAAI,CAAC,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;gBACzD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,IAAA,oBAAI,EAAC,4BAA4B,EAAE,GAAG,EAAE;YACtC,MAAM,KAAK,GAAU;gBACnB,EAAE,EAAE,CAAC;gBACL,SAAS,EAAE,KAAK;aACjB,CAAC;YACF,IAAA,oBAAI,EACF,wBAAwB,EACxB,EAAE,OAAO,EAAE,6BAA6B,EAAE,EAC1C,GAAG,EAAE;gBACH,MAAM,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACnD,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "test-fns",
   "author": "ehmpathy",
   "description": "write usecase driven tests systematically for simpler, safer, and more readable code",
-  "version": "1.0.3",
+  "version": "1.1.1",
   "repository": "ehmpathy/test-fns",
   "homepage": "https://github.com/ehmpathy/test-fns",
   "keywords": [