test-fns 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Uladzimir Kasacheuski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/givenWhenThen.d.ts

@@ -0,0 +1,3 @@
+export declare const given: (desc: string, fn: () => Promise<void> | void) => void;
+export declare const when: (desc: string, fn: () => Promise<void> | void) => void;
+export declare const then: (desc: string, fn: () => Promise<void> | void) => void;

package/dist/givenWhenThen.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.then = exports.when = exports.given = void 0;
+const given = (desc, fn) => describe(`given: ${desc}`, fn);
+exports.given = given;
+const when = (desc, fn) => describe(`when: ${desc}`, fn);
+exports.when = when;
+const then = (desc, fn) => test(`then: ${desc}`, fn);
+exports.then = then;
+//# sourceMappingURL=givenWhenThen.js.map

package/dist/givenWhenThen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"givenWhenThen.js","sourceRoot":"","sources":["../src/givenWhenThen.ts"],"names":[],"mappings":";;;AAAO,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAA8B,EAAQ,EAAE,CAC1E,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AADpB,QAAA,KAAK,SACe;AAC1B,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAA8B,EAAQ,EAAE,CACzE,QAAQ,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;AADnB,QAAA,IAAI,QACe;AACzB,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAA8B,EAAQ,EAAE,CACzE,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAS,CAAC,CAAC;AADtB,QAAA,IAAI,QACkB"}

package/dist/givenWhenThen.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/givenWhenThen.test.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const givenWhenThen_1 = require("./givenWhenThen");
+const doesPlantNeedWater = (plant) => plant.hydration === 'DRY';
+describe('doesPlantNeedWater', () => {
+    (0, givenWhenThen_1.given)('a plant', () => {
+        (0, givenWhenThen_1.when)('the plant doesnt have enough water', () => {
+            const plant = {
+                id: 7,
+                hydration: 'DRY',
+            };
+            (0, givenWhenThen_1.then)('it should return true', () => {
+                expect(doesPlantNeedWater(plant)).toEqual(true);
+            });
+        });
+    });
+});
+//# sourceMappingURL=givenWhenThen.test.js.map

package/dist/givenWhenThen.test.js.map

@@ -0,0 +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;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "test-fns",
+  "author": "ehmpathy",
+  "description": "write usecase driven tests systematically for simpler, safer, and more readable code",
+  "version": "1.0.0",
+  "repository": "ehmpathy/test-fns",
+  "homepage": "https://github.com/ehmpathy/test-fns",
+  "keywords": [
+    "test",
+    "usecase",
+    "given",
+    "when",
+    "then",
+    "behavior"
+  ],
+  "bugs": "https://github.com/ehmpathy/test-fns/issues",
+  "main": "dist/index.js",
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "commit:with-cli": "npx cz",
+    "fix:format:prettier": "prettier --write '**/*.ts' --config ./prettier.config.js",
+    "fix:format": "npm run fix:format:prettier",
+    "fix:lint": "eslint -c ./.eslintrc.js src/**/*.ts --fix",
+    "build:artifact": "echo 'no artifact'",
+    "build:clean": "rm dist/ -rf",
+    "build:compile": "tsc -p ./tsconfig.build.json",
+    "build": "npm run build:clean && npm run build:compile",
+    "test:commits": "LAST_TAG=$(git describe --tags --abbrev=0 @^ 2> /dev/null || git rev-list --max-parents=0 HEAD) && npx commitlint --from $LAST_TAG --to HEAD --verbose",
+    "test:types": "tsc -p ./tsconfig.build.json --noEmit",
+    "test:format:prettier": "prettier --parser typescript --check 'src/**/*.ts' --config ./prettier.config.js",
+    "test:format": "npm run test:format:prettier",
+    "test:lint:deps": "npx depcheck -c ./depcheckrc.yml",
+    "test:lint:eslint": "eslint -c ./.eslintrc.js src/**/*.ts",
+    "test:lint": "npm run test:lint:eslint && npm run test:lint:deps",
+    "test:unit": "jest -c ./jest.unit.config.ts --forceExit --verbose --passWithNoTests",
+    "test:integration": "jest -c ./jest.integration.config.ts --forceExit --verbose --passWithNoTests",
+    "test:acceptance:locally": "npm run build && LOCALLY=true jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests",
+    "test": "npm run test:commits && npm run test:types && npm run test:format && npm run test:lint && npm run test:unit && npm run test:integration && npm run test:acceptance:locally",
+    "test:acceptance": "npm run build && jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests",
+    "prepush": "npm run test && npm run build",
+    "prepublish": "npm run build",
+    "preversion": "npm run prepush",
+    "postversion": "git push origin HEAD --tags --no-verify",
+    "postinstall": "[ -d .git ] && npx husky install || exit 0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "17.7.1",
+    "@commitlint/config-conventional": "13.1.0",
+    "@trivago/prettier-plugin-sort-imports": "2.0.4",
+    "@tsconfig/node-lts-strictest": "18.12.1",
+    "@types/jest": "29.2.4",
+    "@typescript-eslint/eslint-plugin": "5.46.1",
+    "@typescript-eslint/parser": "5.46.1",
+    "core-js": "3.26.1",
+    "cz-conventional-changelog": "3.3.0",
+    "declapract": "0.11.2",
+    "declapract-typescript-ehmpathy": "0.27.2",
+    "depcheck": "1.4.3",
+    "eslint": "8.30.0",
+    "eslint-config-airbnb-typescript": "17.0.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "husky": "8.0.3",
+    "jest": "29.3.1",
+    "prettier": "2.8.1",
+    "ts-jest": "29.0.3",
+    "ts-node": "10.9.1",
+    "typescript": "4.9.4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "license": "MIT"
+}

package/readme.md

@@ -0,0 +1,52 @@
+# test-fns
+
+![ci_on_commit](https://github.com/ehmpathy/test-fns/workflows/ci_on_commit/badge.svg)
+![deploy_on_tag](https://github.com/ehmpathy/test-fns/workflows/deploy_on_tag/badge.svg)
+
+write usecase driven tests systematically for simpler, safer, and more readable code
+
+# purpose
+
+establishes a pattern of writing tests for simpler, safer, and more readable code.
+
+by defining tests in terms of usecases (`given`, `when`, `then`) your tests are
+- simpler to write
+- easier to read
+- safer to trust
+
+# install
+
+```sh
+npm install --save test-fns
+```
+
+# use
+
+```ts
+type Plant = { id: number, hydration: 'DRY' | 'WET' };
+const doesPlantNeedWater = (plant: Plant) => plant.hydration === 'DRY';
+
+describe('doesPlantNeedWater', () => {
+  given('a plant', () => {
+    when('the plant doesnt have enough water', () => {
+      const plant: Plant = {
+        id: 7,
+        hydration: 'DRY',
+      };
+      then('it should return true', () => {
+        expect(doesPlantNeedWater(plant)).toEqual(true)
+      })
+    })
+  })
+})
+```
+
+produces
+
+```sh
+ PASS  src/givenWhenThen.test.ts
+  doesPlantNeedWater
+    given: a plant
+      when: the plant doesnt have enough water
+        ✓ then: it should return true (1 ms)
+```