@systemfsoftware/storybook-gherkin 2.0.1 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @systemfsoftware/storybook-gherkin
 
+## 3.0.0
+
+### Major Changes
+
+- Scenario titles are now enforced as prose at the type level: `scenario` and `scenarioOutline` reject any title that either starts with "Should" (the `Should_[Behavior]_When_[Condition]` unit-test naming convention) or lacks an ASCII space between words (every concatenated-token shape — PascalCase, snake_case, CamelCase — that reads as a unit-test name rather than prose). A rejected title fails to type-check with the rule in the diagnostic. Titles that are not string literals are unaffected.
+
+## 2.0.2
+
+### Patch Changes
+
+- Peer Effect requirement advances to 4.0.0-rc.112. No API changes.
+
 ## 2.0.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -195,16 +195,30 @@ interface FeatureOptions {
  * `Steps(...)` / `From(...)`, or — in first position only — an options object.
  */
 type StepArg<TArgs> = Step<TArgs> | readonly Step<TArgs>[];
+/**
+ * A scenario title names a concrete situation in natural-language prose. Two
+ * shape checks keep DAMP `Should_[Behavior]_When_[Condition]` unit-test names —
+ * and every concatenated-token title shaped like one — out of the call site:
+ *  1. the literal must not start with `Should`;
+ *  2. the literal must contain at least one ASCII space (a single-word title is
+ *     a test name, not prose).
+ * Either check failing maps to `ScenarioTitleRejected`, so the call fails to
+ * type-check with the rule in the diagnostic. Non-literal titles (widened
+ * `string`) pass through untouched — a runtime guard would catch those, but
+ * the brand is the contract this skill ships.
+ */
+type ScenarioTitleRejected<T extends string> = `Scenario titles are natural-language prose of a concrete situation, not DAMP Should_[Behavior]_When_[Condition] unit-test names. Got: ${T}` | `Scenario title must be natural-language prose (at least one space separates words); got: ${T}`;
+type ScenarioTitle<T extends string> = T extends `Should${string}` ? ScenarioTitleRejected<T> : T extends `${string} ${string}` ? T : ScenarioTitleRejected<T>;
 interface ScenarioFn<TArgs> {
-  (name: string, ...steps: readonly StepArg<TArgs>[]): StorySpec<TArgs>;
-  (name: string, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): StorySpec<TArgs>;
+  <TName extends string>(name: ScenarioTitle<TName>, ...steps: readonly StepArg<TArgs>[]): StorySpec<TArgs>;
+  <TName extends string>(name: ScenarioTitle<TName>, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): StorySpec<TArgs>;
 }
 interface OutlineBuilder<TArgs> {
   readonly examples: (rows: readonly ExampleRow[]) => Record<string, StorySpec<TArgs>>;
 }
 interface OutlineFn<TArgs> {
-  (name: string, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
-  (name: string, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
+  <TName extends string>(name: ScenarioTitle<TName>, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
+  <TName extends string>(name: ScenarioTitle<TName>, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
 }
 interface RuleScope<TArgs> {
   readonly scenario: ScenarioFn<TArgs>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@systemfsoftware/storybook-gherkin",
   "license": "Apache-2.0",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "author": "Ryan Lee <drdgvhbh@gmail.com>",
   "repository": {
     "type": "git",
@@ -39,7 +39,7 @@
     "type-fest": "^5.8.0"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-rc.111",
+    "effect": "^4.0.0-rc.112",
     "storybook": ">=10.0.0"
   },
   "devDependencies": {
@@ -51,7 +51,7 @@
     "@types/react-dom": "^19.2.4",
     "@vitest/browser": "^4",
     "@vitest/browser-playwright": "^4",
-    "effect": "4.0.0-rc.111",
+    "effect": "^4.0.0-rc.112",
     "oxlint": "^1.77.0",
     "playwright": "^1",
     "react": "^19.2.8",
@@ -62,8 +62,8 @@
     "typescript": "^7",
     "vite": "^8",
     "vitest": "^4.1.10",
-    "@systemfsoftware/tsconfig": "^1.3.3",
-    "@systemfsoftware/oxlint-config": "^0.1.0"
+    "@systemfsoftware/oxlint-config": "^0.1.0",
+    "@systemfsoftware/tsconfig": "^1.3.3"
   },
   "publishConfig": {
     "provenance": true