vitest-gwt 4.0.0 → 4.0.1-beta.3

package/README.md

@@ -1,4 +1,5 @@
 # vitest-gwt
+
 A small library to help Vitest support given-when-then style testing without a
 bunch of overhead
 
@@ -10,32 +11,32 @@ vitest@2.x.x, use vitest-gwt@2.x.x
 ## Usage
 
 1. Install the package
-    ```bash
-    npm i --save-dev vitest-gwt
-    ```
+   ```bash
+   npm i --save-dev vitest-gwt
+   ```
 2. In your test files, import `test`
-    ```js
-    import test from 'vitest-gwt';
-    ```
+   ```js
+   import test from "vitest-gwt";
+   ```
 3. Write a test!
-    ```js
-    describe('test context', () => {
-      test('has no expected errors', {
-        given: {
-          mock_vitest_test_function,
-          GOOD_test_case,
-        },
-        when: {
-          executing_test_case,
-        },
-        then: {
-          all_GIVENS_called,
-          all_WHENS_called,
-          all_THENS_called,
-        },
-      });
-    });
-    ```
+   ```js
+   describe("test context", () => {
+     test("has no expected errors", {
+       given: {
+         mock_vitest_test_function,
+         GOOD_test_case,
+       },
+       when: {
+         executing_test_case,
+       },
+       then: {
+         all_GIVENS_called,
+         all_WHENS_called,
+         all_THENS_called,
+       },
+     });
+   });
+   ```
 
 ## [Scenario Test](https://github.com/devzeebo/gwt-runner/blob/main/README.md#scenario-definition)
 
@@ -81,29 +82,6 @@ In these cases, you can use the scenario definition style which allows chaining
 }
 ```
 
-## Disabling a test
-Sometimes you want a test to be disabled in code. Vitest offers this functionality with
-the `xtest` method, and we've duplicated this logic, but with strong typing so you can
-disable your gwt style tests.
-
-```js
-import test, { xtest } from 'vitest-gwt';
-
-describe('test context', () => {
-  test('this test will run', {
-    then: {
-      CANARY,
-    },
-  });
-
-  xtest('this test will NOT run', {
-    when: {
-      oops_we_broke_this,
-    },
-  });
-});
-```
-
 ## withAspect
 
 `withAspect` wraps up vitest's `beforeEach` and `afterEach` to allow preparing and
@@ -125,8 +103,10 @@ The `afterEach` has access to whatever values you put on the Context in the
 `beforeEach`. It does NOT have access to the values put on the Context during
 the specific test.
 
-
 ## Detailed Usage
 
-Please refer to [gwt-runner](https://github.com/devzeebo/gwt-runner) for
-detailed usage on how to write tests and clauses.
+Full guides live in [`docs/`](./docs) — writing tests, expecting errors,
+scenarios, shared context (`withAspect`), and the API reference.
+
+For the underlying runner internals, refer to
+[gwt-runner](https://github.com/devzeebo/gwt-runner).

package/lib/index.cjs

@@ -0,0 +1,27 @@
+Object.defineProperties(exports, {
+	__esModule: { value: true },
+	[Symbol.toStringTag]: { value: "Module" }
+});
+let vitest = require("vitest");
+let gwt_runner = require("gwt-runner");
+//#region src/withAspect.ts
+const withAspectBuilder = (beforeEach, afterEach) => (before, after) => {
+	beforeEach(async () => {
+		gwt_runner.TestContext.createContext();
+		await before.bind(gwt_runner.TestContext.context)();
+	});
+	afterEach(async () => {
+		if (after) await after.bind(gwt_runner.TestContext.context)();
+		gwt_runner.TestContext.releaseContext();
+	});
+};
+//#endregion
+//#region src/index.ts
+const test = (0, gwt_runner.gwtRunner)(vitest.test);
+const withAspect = withAspectBuilder(vitest.beforeEach, vitest.afterEach);
+//#endregion
+exports.TestContext = gwt_runner.TestContext;
+exports.default = test;
+exports.withAspect = withAspect;
+
+//# sourceMappingURL=index.cjs.map

package/lib/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["TestContext","vitestBeforeEach","vitestAfterEach"],"sources":["../src/withAspect.ts","../src/index.ts"],"sourcesContent":["import type { beforeEach as vitestBeforeEach, afterEach as vitestAfterEach } from \"vitest\";\nimport { TestContext } from \"gwt-runner\";\n\ntype Callback<T> = (this: T) => any;\n\nexport type WithAspectBuilder = (\n  beforeEach: typeof vitestBeforeEach,\n  afterEach: typeof vitestAfterEach,\n) => <T>(before: Callback<T>, after?: Callback<T>) => void;\n\nconst withAspectBuilder: WithAspectBuilder =\n  (beforeEach, afterEach) =>\n  <T>(before: Callback<T>, after?: Callback<T>): void => {\n    beforeEach(async () => {\n      TestContext.createContext();\n\n      await (before.bind(TestContext.context as T) as any)();\n    });\n\n    afterEach(async () => {\n      if (after) {\n        await (after.bind(TestContext.context as T) as any)();\n      }\n\n      TestContext.releaseContext();\n    });\n  };\n\nexport default withAspectBuilder;\n","import {\n  test as vitest,\n  beforeEach as vitestBeforeEach,\n  afterEach as vitestAfterEach,\n} from \"vitest\";\nimport { gwtRunner, TestContext } from \"gwt-runner\";\nimport withAspectBuilder, { type WithAspectBuilder } from \"./withAspect\";\n\nconst test: ReturnType<typeof gwtRunner> = gwtRunner(vitest);\n\nexport default test;\nexport { TestContext };\n\nexport const withAspect: ReturnType<WithAspectBuilder> = withAspectBuilder(\n  vitestBeforeEach,\n  vitestAfterEach,\n);\n"],"mappings":";;;;;;;AAUA,MAAM,qBACH,YAAY,eACT,QAAqB,UAA8B;CACrD,WAAW,YAAY;EACrB,WAAA,YAAY,cAAc;EAE1B,MAAO,OAAO,KAAKA,WAAAA,YAAY,OAAY,CAAC,CAAS;CACvD,CAAC;CAED,UAAU,YAAY;EACpB,IAAI,OACF,MAAO,MAAM,KAAKA,WAAAA,YAAY,OAAY,CAAC,CAAS;EAGtD,WAAA,YAAY,eAAe;CAC7B,CAAC;AACH;;;AClBF,MAAM,QAAA,GAAA,WAAA,UAAA,CAA+C,OAAA,IAAM;AAK3D,MAAa,aAA4C,kBACvDC,OAAAA,YACAC,OAAAA,SACF"}

package/lib/index.d.cts

@@ -0,0 +1,13 @@
+import { TestContext, gwtRunner } from "gwt-runner";
+import { afterEach, beforeEach } from "vitest";
+
+//#region src/withAspect.d.ts
+type Callback<T> = (this: T) => any;
+type WithAspectBuilder = (beforeEach: typeof beforeEach, afterEach: typeof afterEach) => <T>(before: Callback<T>, after?: Callback<T>) => void;
+//#endregion
+//#region src/index.d.ts
+declare const test: ReturnType<typeof gwtRunner>;
+declare const withAspect: ReturnType<WithAspectBuilder>;
+//#endregion
+export { TestContext, test as default, withAspect };
+//# sourceMappingURL=index.d.cts.map

package/lib/index.d.mts

@@ -0,0 +1,13 @@
+import { afterEach, beforeEach } from "vitest";
+import { TestContext, gwtRunner } from "gwt-runner";
+
+//#region src/withAspect.d.ts
+type Callback<T> = (this: T) => any;
+type WithAspectBuilder = (beforeEach: typeof beforeEach, afterEach: typeof afterEach) => <T>(before: Callback<T>, after?: Callback<T>) => void;
+//#endregion
+//#region src/index.d.ts
+declare const test: ReturnType<typeof gwtRunner>;
+declare const withAspect: ReturnType<WithAspectBuilder>;
+//#endregion
+export { TestContext, test as default, withAspect };
+//# sourceMappingURL=index.d.mts.map

package/lib/index.mjs

@@ -0,0 +1,21 @@
+import { afterEach, beforeEach, test as test$1 } from "vitest";
+import { TestContext, TestContext as TestContext$1, gwtRunner } from "gwt-runner";
+//#region src/withAspect.ts
+const withAspectBuilder = (beforeEach, afterEach) => (before, after) => {
+	beforeEach(async () => {
+		TestContext$1.createContext();
+		await before.bind(TestContext$1.context)();
+	});
+	afterEach(async () => {
+		if (after) await after.bind(TestContext$1.context)();
+		TestContext$1.releaseContext();
+	});
+};
+//#endregion
+//#region src/index.ts
+const test = gwtRunner(test$1);
+const withAspect = withAspectBuilder(beforeEach, afterEach);
+//#endregion
+export { TestContext, test as default, withAspect };
+
+//# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["TestContext","vitest","vitestBeforeEach","vitestAfterEach"],"sources":["../src/withAspect.ts","../src/index.ts"],"sourcesContent":["import type { beforeEach as vitestBeforeEach, afterEach as vitestAfterEach } from \"vitest\";\nimport { TestContext } from \"gwt-runner\";\n\ntype Callback<T> = (this: T) => any;\n\nexport type WithAspectBuilder = (\n  beforeEach: typeof vitestBeforeEach,\n  afterEach: typeof vitestAfterEach,\n) => <T>(before: Callback<T>, after?: Callback<T>) => void;\n\nconst withAspectBuilder: WithAspectBuilder =\n  (beforeEach, afterEach) =>\n  <T>(before: Callback<T>, after?: Callback<T>): void => {\n    beforeEach(async () => {\n      TestContext.createContext();\n\n      await (before.bind(TestContext.context as T) as any)();\n    });\n\n    afterEach(async () => {\n      if (after) {\n        await (after.bind(TestContext.context as T) as any)();\n      }\n\n      TestContext.releaseContext();\n    });\n  };\n\nexport default withAspectBuilder;\n","import {\n  test as vitest,\n  beforeEach as vitestBeforeEach,\n  afterEach as vitestAfterEach,\n} from \"vitest\";\nimport { gwtRunner, TestContext } from \"gwt-runner\";\nimport withAspectBuilder, { type WithAspectBuilder } from \"./withAspect\";\n\nconst test: ReturnType<typeof gwtRunner> = gwtRunner(vitest);\n\nexport default test;\nexport { TestContext };\n\nexport const withAspect: ReturnType<WithAspectBuilder> = withAspectBuilder(\n  vitestBeforeEach,\n  vitestAfterEach,\n);\n"],"mappings":";;;AAUA,MAAM,qBACH,YAAY,eACT,QAAqB,UAA8B;CACrD,WAAW,YAAY;EACrB,cAAY,cAAc;EAE1B,MAAO,OAAO,KAAKA,cAAY,OAAY,CAAC,CAAS;CACvD,CAAC;CAED,UAAU,YAAY;EACpB,IAAI,OACF,MAAO,MAAM,KAAKA,cAAY,OAAY,CAAC,CAAS;EAGtD,cAAY,eAAe;CAC7B,CAAC;AACH;;;AClBF,MAAM,OAAqC,UAAUC,MAAM;AAK3D,MAAa,aAA4C,kBACvDC,YACAC,SACF"}

package/package.json

@@ -1,14 +1,48 @@
 {
   "name": "vitest-gwt",
-  "version": "4.0.0",
+  "version": "4.0.1-beta.3",
   "description": "A small library to help Vitest support given-when-then style testing without a bunch of overhead",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "keywords": [
+    "given",
+    "gwt",
+    "testing",
+    "then",
+    "unit",
+    "vitest",
+    "when"
+  ],
+  "homepage": "https://github.com/devzeebo/vitest-gwt#readme",
+  "bugs": {
+    "url": "https://github.com/devzeebo/vitest-gwt/issues"
+  },
+  "license": "MIT",
+  "author": "Eric Siebeneich",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/devzeebo/vitest-gwt.git"
+  },
   "files": [
     "lib",
     "src",
     "!**/*.spec.ts"
   ],
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.mjs",
+  "types": "./lib/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./lib/index.d.cts",
+        "default": "./lib/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "build": "wireit",
     "test": "wireit",
@@ -16,12 +50,28 @@
     "test:coverage": "wireit",
     "prepublishOnly": "wireit"
   },
+  "dependencies": {
+    "gwt-runner": "^3.0.0-esm.5"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.3",
+    "@vitest/coverage-v8": "^4.1.9",
+    "axios": "^1.18.0",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.9",
+    "wireit": "^0.14.12"
+  },
+  "peerDependencies": {
+    "vitest": ">=4.0.0"
+  },
+  "packageManager": "npm@11.12.1",
   "wireit": {
     "build": {
-      "command": "tsc --project ./tsconfig.build.json",
+      "command": "vp pack",
       "files": [
         "src/**/*.ts",
-        "tsconfig.*",
+        "tsconfig.json",
+        "vite.config.ts",
         "!src/**/*.spec.ts"
       ],
       "output": [
@@ -29,56 +79,36 @@
       ]
     },
     "lint": {
-      "command": "eslint ./src"
+      "command": "vp lint src",
+      "files": [
+        "src/**/*.ts",
+        "tsconfig.json",
+        "vite.config.ts"
+      ]
     },
     "test": {
-      "command": "vitest run"
+      "command": "vp test run",
+      "files": [
+        "src/**/*.ts",
+        "vite.config.ts"
+      ]
     },
     "test:coverage": {
-      "command": "vitest run --coverage"
+      "command": "vp test run --coverage",
+      "files": [
+        "src/**/*.ts",
+        "vite.config.ts"
+      ],
+      "output": [
+        "coverage/**"
+      ]
     },
     "prepublishOnly": {
       "dependencies": [
         "lint",
-        "test:coverage",
+        "test",
         "build"
       ]
     }
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/devzeebo/vitest-gwt.git"
-  },
-  "peerDependencies": {
-    "vitest": ">=4.0.0"
-  },
-  "keywords": [
-    "vitest",
-    "gwt",
-    "unit",
-    "testing",
-    "given",
-    "when",
-    "then"
-  ],
-  "author": "Eric Siebeneich",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/devzeebo/vitest-gwt/issues"
-  },
-  "homepage": "https://github.com/devzeebo/vitest-gwt#readme",
-  "devDependencies": {
-    "@react-ddd/eslint-config": "^0.4.0",
-    "@types/lodash": "^4.17.24",
-    "@types/node": "^25.9.1",
-    "@vitest/coverage-v8": "^4.1.8",
-    "axios": "^1.17.0",
-    "lodash": "^4.18.1",
-    "typescript": "^6.0.3",
-    "vitest": ">=4.1.8",
-    "wireit": "^0.14.12"
-  },
-  "dependencies": {
-    "gwt-runner": "^2.4.0"
   }
-}
+}

package/src/index.ts

@@ -2,11 +2,16 @@ import {
   test as vitest,
   beforeEach as vitestBeforeEach,
   afterEach as vitestAfterEach,
-} from 'vitest';
-import gwtRunner, { TestContext } from 'gwt-runner';
-import withAspectBuilder from './withAspect';
+} from "vitest";
+import { gwtRunner, TestContext } from "gwt-runner";
+import withAspectBuilder, { type WithAspectBuilder } from "./withAspect";
 
-export default gwtRunner(vitest);
+const test: ReturnType<typeof gwtRunner> = gwtRunner(vitest);
+
+export default test;
 export { TestContext };
 
-export const withAspect = withAspectBuilder(vitestBeforeEach, vitestAfterEach);
+export const withAspect: ReturnType<WithAspectBuilder> = withAspectBuilder(
+  vitestBeforeEach,
+  vitestAfterEach,
+);

package/src/withAspect.ts

@@ -1,19 +1,16 @@
-import type {
-  beforeEach as vitestBeforeEach,
-  afterEach as vitestAfterEach,
-} from 'vitest';
-import { TestContext } from 'gwt-runner';
+import type { beforeEach as vitestBeforeEach, afterEach as vitestAfterEach } from "vitest";
+import { TestContext } from "gwt-runner";
 
 type Callback<T> = (this: T) => any;
 
-export default (
+export type WithAspectBuilder = (
   beforeEach: typeof vitestBeforeEach,
   afterEach: typeof vitestAfterEach,
-) => (
-  <T>(
-    before: Callback<T>,
-    after?: Callback<T>,
-  ) => {
+) => <T>(before: Callback<T>, after?: Callback<T>) => void;
+
+const withAspectBuilder: WithAspectBuilder =
+  (beforeEach, afterEach) =>
+  <T>(before: Callback<T>, after?: Callback<T>): void => {
     beforeEach(async () => {
       TestContext.createContext();
 
@@ -27,5 +24,6 @@ export default (
 
       TestContext.releaseContext();
     });
-  }
-);
+  };
+
+export default withAspectBuilder;

package/lib/index.d.ts

@@ -1,5 +0,0 @@
-import { TestContext } from 'gwt-runner';
-declare const _default: <TContext>(name: string, gwtDefinition: import("gwt-runner").GwtDefinition<TContext>) => void;
-export default _default;
-export { TestContext };
-export declare const withAspect: <T>(before: (this: T) => any, after?: (this: T) => any) => void;

package/lib/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.withAspect = exports.TestContext = void 0;
-const tslib_1 = require("tslib");
-const vitest_1 = require("vitest");
-const gwt_runner_1 = tslib_1.__importStar(require("gwt-runner"));
-Object.defineProperty(exports, "TestContext", { enumerable: true, get: function () { return gwt_runner_1.TestContext; } });
-const withAspect_1 = tslib_1.__importDefault(require("./withAspect"));
-exports.default = (0, gwt_runner_1.default)(vitest_1.test);
-exports.withAspect = (0, withAspect_1.default)(vitest_1.beforeEach, vitest_1.afterEach);
-//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,mCAIgB;AAChB,iEAAoD;AAI3C,4FAJW,wBAAW,OAIX;AAHpB,sEAA6C;AAE7C,kBAAe,IAAA,oBAAS,EAAC,aAAM,CAAC,CAAC;AAGpB,QAAA,UAAU,GAAG,IAAA,oBAAiB,EAAC,mBAAgB,EAAE,kBAAe,CAAC,CAAC"}

package/lib/withAspect.d.ts

@@ -1,4 +0,0 @@
-import type { beforeEach as vitestBeforeEach, afterEach as vitestAfterEach } from 'vitest';
-type Callback<T> = (this: T) => any;
-declare const _default: (beforeEach: typeof vitestBeforeEach, afterEach: typeof vitestAfterEach) => <T>(before: Callback<T>, after?: Callback<T>) => void;
-export default _default;

package/lib/withAspect.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const gwt_runner_1 = require("gwt-runner");
-exports.default = (beforeEach, afterEach) => ((before, after) => {
-    beforeEach(async () => {
-        gwt_runner_1.TestContext.createContext();
-        await before.bind(gwt_runner_1.TestContext.context)();
-    });
-    afterEach(async () => {
-        if (after) {
-            await after.bind(gwt_runner_1.TestContext.context)();
-        }
-        gwt_runner_1.TestContext.releaseContext();
-    });
-});
-//# sourceMappingURL=withAspect.js.map

package/lib/withAspect.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"withAspect.js","sourceRoot":"","sources":["../src/withAspect.ts"],"names":[],"mappings":";;AAIA,2CAAyC;AAIzC,kBAAe,CACb,UAAmC,EACnC,SAAiC,EACjC,EAAE,CAAC,CACH,CACE,MAAmB,EACnB,KAAmB,EACnB,EAAE;IACF,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,wBAAW,CAAC,aAAa,EAAE,CAAC;QAE5B,MAAO,MAAM,CAAC,IAAI,CAAC,wBAAW,CAAC,OAAY,CAAS,EAAE,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,IAAI,KAAK,EAAE,CAAC;YACV,MAAO,KAAK,CAAC,IAAI,CAAC,wBAAW,CAAC,OAAY,CAAS,EAAE,CAAC;QACxD,CAAC;QAED,wBAAW,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC,CACF,CAAC"}