@systemfsoftware/storybook-gherkin 4.0.2 → 4.0.3

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @systemfsoftware/storybook-gherkin
 
+## 4.0.3
+
+### Patch Changes
+
+- Every tagged error class now has a one-line message built from its fields, so a failure shows what went wrong instead of an empty message.
+
+- A step whose story is left mid-step (Storybook aborts the play, for example when the visit moves to another story) now always settles the promise handed to Storybook's `step`. Before, an abort that landed just as a step started could leave that promise pending, so Storybook waited on it forever.
+
+- Update peer and runtime dependency on `effect` and companion packages to `4.0.0-rc.117`.
+
 ## 4.0.2
 
 ### Patch Changes

package/README.md

@@ -20,4 +20,4 @@ The public surface is generated from the source and versioned with the package:
 
 ## License
 
-Apache-2.0. Part of [systemfsoftware](https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/storybook-gherkin#readme).
+Apache-2.0. Part of [systemfsoftware](https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/gherkin/storybook-gherkin#readme).

package/dist/index.d.ts

@@ -15,7 +15,9 @@ declare type AnyConstraintDecoder<A = unknown> = Schema.ConstraintDecoder<A>;
 
 declare type AnyValue<V = unknown> = V;
 
-export declare class BackgroundNotGiven extends BackgroundNotGiven_base {}
+export declare class BackgroundNotGiven extends BackgroundNotGiven_base {
+    get message(): string;
+}
 
 declare const BackgroundNotGiven_base: Schema.Class<BackgroundNotGiven, Schema.TaggedStruct<"BackgroundNotGiven", {
     readonly step: Schema.String;
@@ -51,7 +53,9 @@ export declare const capture: {
     }): Capture<Name, string>;
 };
 
-export declare class CaptureDecodeFailed extends CaptureDecodeFailed_base {}
+export declare class CaptureDecodeFailed extends CaptureDecodeFailed_base {
+    get message(): string;
+}
 
 declare const CaptureDecodeFailed_base: Schema.Class<CaptureDecodeFailed, Schema.TaggedStruct<"CaptureDecodeFailed", {
     readonly step: Schema.String;
@@ -75,7 +79,9 @@ declare type CaptureTag = typeof CaptureTag;
 
 export declare type ConcreteKeyword = 'Given' | 'When' | 'Then';
 
-export declare class DuplicateCapture extends DuplicateCapture_base {}
+export declare class DuplicateCapture extends DuplicateCapture_base {
+    get message(): string;
+}
 
 declare const DuplicateCapture_base: Schema.Class<DuplicateCapture, Schema.TaggedStruct<"DuplicateCapture", {
     readonly step: Schema.String;
@@ -90,7 +96,9 @@ declare const DuplicateCapture_base: Schema.Class<DuplicateCapture, Schema.Tagge
  * - Run time: `CaptureDecodeFailed` travels the typed error channel of
  *   `Step.run` and surfaces when the play edge interprets the scenario.
  */
-export declare class EmptyScenario extends EmptyScenario_base {}
+export declare class EmptyScenario extends EmptyScenario_base {
+    get message(): string;
+}
 
 declare const EmptyScenario_base: Schema.Class<EmptyScenario, Schema.TaggedStruct<"EmptyScenario", {
     readonly scenario: Schema.String;
@@ -138,7 +146,9 @@ export declare type Hole = Capture | string | number;
 export declare type Keyword = 'Given' | 'When' | 'Then' | 'And' | 'But' | 'Star';
 
 /** Without a Then-phase step nothing is asserted — the scenario is not a spec. */
-export declare class MissingThen extends MissingThen_base {}
+export declare class MissingThen extends MissingThen_base {
+    get message(): string;
+}
 
 declare const MissingThen_base: Schema.Class<MissingThen, Schema.TaggedStruct<"MissingThen", {
     readonly scenario: Schema.String;
@@ -149,14 +159,18 @@ export declare interface OutlineBuilder<TArgs> {
 }
 
 /** Row names become the exported story names, so duplicates would collide. */
-export declare class OutlineDuplicateRowName extends OutlineDuplicateRowName_base {}
+export declare class OutlineDuplicateRowName extends OutlineDuplicateRowName_base {
+    get message(): string;
+}
 
 declare const OutlineDuplicateRowName_base: Schema.Class<OutlineDuplicateRowName, Schema.TaggedStruct<"OutlineDuplicateRowName", {
     readonly outline: Schema.String;
     readonly name: Schema.String;
 }>, YieldableError>;
 
-export declare class OutlineEmpty extends OutlineEmpty_base {}
+export declare class OutlineEmpty extends OutlineEmpty_base {
+    get message(): string;
+}
 
 declare const OutlineEmpty_base: Schema.Class<OutlineEmpty, Schema.TaggedStruct<"OutlineEmpty", {
     readonly outline: Schema.String;
@@ -167,7 +181,9 @@ export declare interface OutlineFn<TArgs> {
     <TName extends string>(name: ScenarioTitle<TName>, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
 }
 
-export declare class OutlineInconsistentKeys extends OutlineInconsistentKeys_base {}
+export declare class OutlineInconsistentKeys extends OutlineInconsistentKeys_base {
+    get message(): string;
+}
 
 declare const OutlineInconsistentKeys_base: Schema.Class<OutlineInconsistentKeys, Schema.TaggedStruct<"OutlineInconsistentKeys", {
     readonly outline: Schema.String;
@@ -176,7 +192,9 @@ declare const OutlineInconsistentKeys_base: Schema.Class<OutlineInconsistentKeys
     readonly actual: Schema.$Array<Schema.String>;
 }>, YieldableError>;
 
-export declare class OutlineMissingCapture extends OutlineMissingCapture_base {}
+export declare class OutlineMissingCapture extends OutlineMissingCapture_base {
+    get message(): string;
+}
 
 declare const OutlineMissingCapture_base: Schema.Class<OutlineMissingCapture, Schema.TaggedStruct<"OutlineMissingCapture", {
     readonly outline: Schema.String;
@@ -316,7 +334,9 @@ declare interface StoryWithPlay<TArgs> {
 export declare const Then: StepCtor;
 
 /** Capture values come from a literal hole, `with`, or an outline row — none matched. */
-export declare class UnresolvedCapture extends UnresolvedCapture_base {}
+export declare class UnresolvedCapture extends UnresolvedCapture_base {
+    get message(): string;
+}
 
 declare const UnresolvedCapture_base: Schema.Class<UnresolvedCapture, Schema.TaggedStruct<"UnresolvedCapture", {
     readonly scenario: Schema.String;

package/dist/index.mjs

@@ -28,46 +28,86 @@ const ConcreteKeywordSchema = Schema.Literals([
 * - Run time: `CaptureDecodeFailed` travels the typed error channel of
 *   `Step.run` and surfaces when the play edge interprets the scenario.
 */
-var EmptyScenario = class extends Schema.TaggedError()("EmptyScenario", { scenario: Schema.String }) {};
+var EmptyScenario = class extends Schema.TaggedError()("EmptyScenario", { scenario: Schema.String }) {
+	get message() {
+		return `Scenario "${this.scenario}" has no steps`;
+	}
+};
 /** Without a Then-phase step nothing is asserted — the scenario is not a spec. */
-var MissingThen = class extends Schema.TaggedError()("MissingThen", { scenario: Schema.String }) {};
+var MissingThen = class extends Schema.TaggedError()("MissingThen", { scenario: Schema.String }) {
+	get message() {
+		return `Scenario "${this.scenario}" has no Then step`;
+	}
+};
 var BackgroundNotGiven = class extends Schema.TaggedError()("BackgroundNotGiven", {
 	step: Schema.String,
 	resolved: ConcreteKeywordSchema
-}) {};
+}) {
+	get message() {
+		return `The background step "${this.step}" is written as ${this.resolved}; a background must be Given`;
+	}
+};
 var DuplicateCapture = class extends Schema.TaggedError()("DuplicateCapture", {
 	step: Schema.String,
 	name: Schema.String
-}) {};
+}) {
+	get message() {
+		return `Step "${this.step}" binds capture "${this.name}" more than once`;
+	}
+};
 /** Capture values come from a literal hole, `with`, or an outline row — none matched. */
 var UnresolvedCapture = class extends Schema.TaggedError()("UnresolvedCapture", {
 	scenario: Schema.String,
 	step: Schema.String,
 	capture: Schema.String
-}) {};
-var OutlineEmpty = class extends Schema.TaggedError()("OutlineEmpty", { outline: Schema.String }) {};
+}) {
+	get message() {
+		return `Capture "${this.capture}" in step "${this.step}" of scenario "${this.scenario}" resolved to no value`;
+	}
+};
+var OutlineEmpty = class extends Schema.TaggedError()("OutlineEmpty", { outline: Schema.String }) {
+	get message() {
+		return `Outline "${this.outline}" has no rows`;
+	}
+};
 var OutlineInconsistentKeys = class extends Schema.TaggedError()("OutlineInconsistentKeys", {
 	outline: Schema.String,
 	row: Schema.String,
 	expected: Schema.Array(Schema.String),
 	actual: Schema.Array(Schema.String)
-}) {};
+}) {
+	get message() {
+		return `Outline "${this.outline}" row "${this.row}" provides [${this.actual.join(", ")}] where the outline declares [${this.expected.join(", ")}]`;
+	}
+};
 /** Row names become the exported story names, so duplicates would collide. */
 var OutlineDuplicateRowName = class extends Schema.TaggedError()("OutlineDuplicateRowName", {
 	outline: Schema.String,
 	name: Schema.String
-}) {};
+}) {
+	get message() {
+		return `Outline "${this.outline}" has more than one row named "${this.name}"`;
+	}
+};
 var OutlineMissingCapture = class extends Schema.TaggedError()("OutlineMissingCapture", {
 	outline: Schema.String,
 	row: Schema.String,
 	capture: Schema.String
-}) {};
+}) {
+	get message() {
+		return `Outline "${this.outline}" row "${this.row}" has no value for capture "${this.capture}"`;
+	}
+};
 var CaptureDecodeFailed = class extends Schema.TaggedError()("CaptureDecodeFailed", {
 	step: Schema.String,
 	capture: Schema.String,
 	value: Schema.String,
 	cause: Schema.Unknown
-}) {};
+}) {
+	get message() {
+		return `Capture "${this.capture}" of step "${this.step}" did not decode: ${this.value}`;
+	}
+};
 //#endregion
 //#region src/Steps.ts
 const emptyIfMissing = (part) => {

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@systemfsoftware/storybook-gherkin",
   "license": "Apache-2.0",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "author": "Ryan Lee <drdgvhbh@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
-    "directory": "packages/storybook-gherkin"
+    "directory": "packages/gherkin/storybook-gherkin"
   },
-  "homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/storybook-gherkin#readme",
+  "homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/gherkin/storybook-gherkin#readme",
   "bugs": "https://github.com/systemfsoftware/systemfsoftware/issues",
   "description": "Feature specs as Storybook stories — Gherkin Given/When/Then embedded in CSF with typed captures and scenario outlines, executing under Storybook's browser-mode play functions.",
   "keywords": [
@@ -43,17 +43,18 @@
     "storybook": ">=10.0.0"
   },
   "devDependencies": {
-    "@systemfsoftware/vitest": "^0.1.0",
     "@microsoft/api-extractor": "^7.59.1",
     "@storybook/addon-vitest": "^10.6.0",
     "@storybook/react-vite": "^10.6.0",
     "@systemfsoftware/arethetypeswrong-cli": "^4.2.0",
-    "@systemfsoftware/conformance-spec": "^0.1.0",
-    "@systemfsoftware/effect-gherkin-spec": "^5.0.0",
-    "@systemfsoftware/effect-sim-kernel": "^0.1.1",
-    "@systemfsoftware/oxlint-config-recommended": "^3.1.0",
+    "@systemfsoftware/conformance-spec": "^0.2.0",
+    "@systemfsoftware/effect-gherkin-spec": "^6.0.0",
+    "@systemfsoftware/effect-sim-kernel": "^0.2.0",
+    "@systemfsoftware/effect-spec-runtime": "^0.3.1",
+    "@systemfsoftware/oxlint-config-recommended": "^3.2.0",
     "@systemfsoftware/tsconfig": "^2.0.1",
     "@systemfsoftware/tsdown-config": "^0.1.0",
+    "@systemfsoftware/vitest": "^0.2.0",
     "@systemfsoftware/vitest-config": "^0.1.0",
     "@types/node": "^26",
     "@types/react": "^19.3.0",
@@ -74,6 +75,7 @@
     "vitest": "^5"
   },
   "publishConfig": {
+    "access": "public",
     "provenance": true
   },
   "scripts": {