@step-forge/step-forge 0.0.5 → 0.0.7-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,14 @@
1
+ export type StepType = "given" | "when" | "then";
2
+ export type InferAndReplace<T, U> = never extends T ? U : T;
3
+ export type HasKeys<T> = T extends Record<any, any> ? (keyof T extends never ? never : T) : T;
4
+ export type EmptyObject = Record<string, never>;
5
+ export type RequiredOrOptional<T> = {
6
+ [K in keyof T]?: "required" | "optional";
7
+ };
8
+ export type GetFunctionArgs<T> = T extends (...args: infer A) => any ? A : never;
9
+ export declare const isString: (statement: string | ((...args: [...any]) => string)) => statement is string;
10
+ export type EmptyDependencies = {
11
+ given: EmptyObject;
12
+ when: EmptyObject;
13
+ then: EmptyObject;
14
+ };
@@ -0,0 +1,32 @@
1
+ import { StepType } from "./builderTypeUtils";
2
+ export declare const addStep: <ResolvedStepType extends StepType, Statement extends (...args: any[]) => string, Dependencies extends {
3
+ given: any;
4
+ when: any;
5
+ then: any;
6
+ }, Variables, GivenState, WhenState, ThenState, RestrictedGivenState, RestrictedWhenState, RestrictedThenState>(statement: Statement, stepType: ResolvedStepType, dependencies?: Dependencies) => (stepFunction: (input: {
7
+ variables: Variables;
8
+ given: RestrictedGivenState;
9
+ when: RestrictedWhenState;
10
+ then: RestrictedThenState;
11
+ }) => ResolvedStepType extends "given" ? Partial<GivenState> : ResolvedStepType extends "when" ? Partial<WhenState> : Partial<ThenState> | void) => {
12
+ statement: Statement;
13
+ dependencies: Dependencies;
14
+ stepType: ResolvedStepType;
15
+ stepFunction: (input: {
16
+ variables: Variables;
17
+ given: RestrictedGivenState;
18
+ when: RestrictedWhenState;
19
+ then: RestrictedThenState;
20
+ }) => ResolvedStepType extends "given" ? Partial<GivenState> : ResolvedStepType extends "when" ? Partial<WhenState> : Partial<ThenState> | void;
21
+ register: () => {
22
+ stepType: ResolvedStepType;
23
+ dependencies: Dependencies;
24
+ statement: Statement;
25
+ stepFunction: (input: {
26
+ variables: Variables;
27
+ given: RestrictedGivenState;
28
+ when: RestrictedWhenState;
29
+ then: RestrictedThenState;
30
+ }) => ResolvedStepType extends "given" ? Partial<GivenState> : ResolvedStepType extends "when" ? Partial<WhenState> : Partial<ThenState> | void;
31
+ };
32
+ };
@@ -0,0 +1,73 @@
1
+ import { EmptyDependencies, EmptyObject, GetFunctionArgs, RequiredOrOptional } from "./builderTypeUtils";
2
+ export declare const givenBuilder: <GivenState>() => {
3
+ statement: <Statement extends ((...args: [...any]) => string) | string>(statement: Statement) => {
4
+ dependencies: <GivenDeps extends RequiredOrOptional<GivenState>>(dependencies: {
5
+ given: GivenDeps;
6
+ }) => {
7
+ step: (stepFunction: (input: {
8
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
9
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
10
+ when: never;
11
+ then: never;
12
+ }) => Partial<GivenState>) => {
13
+ statement: Statement extends string ? () => string : Statement;
14
+ dependencies: {
15
+ given: GivenDeps;
16
+ } & {
17
+ when: EmptyObject;
18
+ then: EmptyObject;
19
+ };
20
+ stepType: "given";
21
+ stepFunction: (input: {
22
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
23
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
24
+ when: never;
25
+ then: never;
26
+ }) => Partial<GivenState>;
27
+ register: () => {
28
+ stepType: "given";
29
+ dependencies: {
30
+ given: GivenDeps;
31
+ } & {
32
+ when: EmptyObject;
33
+ then: EmptyObject;
34
+ };
35
+ statement: Statement extends string ? () => string : Statement;
36
+ stepFunction: (input: {
37
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
38
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
39
+ when: never;
40
+ then: never;
41
+ }) => Partial<GivenState>;
42
+ };
43
+ };
44
+ };
45
+ step: (stepFunction: (input: {
46
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
47
+ given: never;
48
+ when: never;
49
+ then: never;
50
+ }) => Partial<GivenState>) => {
51
+ statement: Statement extends string ? () => string : Statement;
52
+ dependencies: EmptyDependencies;
53
+ stepType: "given";
54
+ stepFunction: (input: {
55
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
56
+ given: never;
57
+ when: never;
58
+ then: never;
59
+ }) => Partial<GivenState>;
60
+ register: () => {
61
+ stepType: "given";
62
+ dependencies: EmptyDependencies;
63
+ statement: Statement extends string ? () => string : Statement;
64
+ stepFunction: (input: {
65
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
66
+ given: never;
67
+ when: never;
68
+ then: never;
69
+ }) => Partial<GivenState>;
70
+ };
71
+ };
72
+ };
73
+ };
@@ -2,5 +2,4 @@ import { givenBuilder } from "./given";
2
2
  import { whenBuilder } from "./when";
3
3
  import { thenBuilder } from "./then";
4
4
  import { BasicWorld } from "./world";
5
-
6
5
  export { givenBuilder, whenBuilder, thenBuilder, BasicWorld };
@@ -0,0 +1,73 @@
1
+ import { EmptyDependencies, GetFunctionArgs, RequiredOrOptional } from "./builderTypeUtils";
2
+ export declare const thenBuilder: <GivenState, WhenState, ThenState>() => {
3
+ statement: <Statement extends ((...args: [...any]) => string) | string>(statement: Statement) => {
4
+ dependencies: <GivenDeps extends RequiredOrOptional<GivenState>, WhenDeps extends RequiredOrOptional<WhenState>, ThenDeps extends RequiredOrOptional<ThenState>>(dependencies: {
5
+ given?: GivenDeps | undefined;
6
+ when?: WhenDeps | undefined;
7
+ then?: ThenDeps | undefined;
8
+ }) => {
9
+ step: (stepFunction: (input: {
10
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
11
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
12
+ when: { [K_1 in keyof WhenState as K_1 extends keyof WhenDeps ? K_1 : never]: WhenDeps[K_1] extends "optional" ? WhenState[K_1] | undefined : WhenState[K_1]; };
13
+ then: { [K_2 in keyof ThenState as K_2 extends keyof ThenDeps ? K_2 : never]: ThenDeps[K_2] extends "optional" ? ThenState[K_2] | undefined : ThenState[K_2]; };
14
+ }) => void | Partial<ThenState>) => {
15
+ statement: Statement extends string ? () => string : Statement;
16
+ dependencies: {
17
+ given: GivenDeps;
18
+ when: WhenDeps;
19
+ then: ThenDeps;
20
+ };
21
+ stepType: "then";
22
+ stepFunction: (input: {
23
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
24
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
25
+ when: { [K_1 in keyof WhenState as K_1 extends keyof WhenDeps ? K_1 : never]: WhenDeps[K_1] extends "optional" ? WhenState[K_1] | undefined : WhenState[K_1]; };
26
+ then: { [K_2 in keyof ThenState as K_2 extends keyof ThenDeps ? K_2 : never]: ThenDeps[K_2] extends "optional" ? ThenState[K_2] | undefined : ThenState[K_2]; };
27
+ }) => void | Partial<ThenState>;
28
+ register: () => {
29
+ stepType: "then";
30
+ dependencies: {
31
+ given: GivenDeps;
32
+ when: WhenDeps;
33
+ then: ThenDeps;
34
+ };
35
+ statement: Statement extends string ? () => string : Statement;
36
+ stepFunction: (input: {
37
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
38
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
39
+ when: { [K_1 in keyof WhenState as K_1 extends keyof WhenDeps ? K_1 : never]: WhenDeps[K_1] extends "optional" ? WhenState[K_1] | undefined : WhenState[K_1]; };
40
+ then: { [K_2 in keyof ThenState as K_2 extends keyof ThenDeps ? K_2 : never]: ThenDeps[K_2] extends "optional" ? ThenState[K_2] | undefined : ThenState[K_2]; };
41
+ }) => void | Partial<ThenState>;
42
+ };
43
+ };
44
+ };
45
+ step: (stepFunction: (input: {
46
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
47
+ given: never;
48
+ when: never;
49
+ then: never;
50
+ }) => void | Partial<ThenState>) => {
51
+ statement: Statement extends string ? () => string : Statement;
52
+ dependencies: EmptyDependencies;
53
+ stepType: "then";
54
+ stepFunction: (input: {
55
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
56
+ given: never;
57
+ when: never;
58
+ then: never;
59
+ }) => void | Partial<ThenState>;
60
+ register: () => {
61
+ stepType: "then";
62
+ dependencies: EmptyDependencies;
63
+ statement: Statement extends string ? () => string : Statement;
64
+ stepFunction: (input: {
65
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
66
+ given: never;
67
+ when: never;
68
+ then: never;
69
+ }) => void | Partial<ThenState>;
70
+ };
71
+ };
72
+ };
73
+ };
@@ -0,0 +1,5 @@
1
+ import { MergeableWorld } from "./world";
2
+ export declare const requireFromGiven: <G>(keys: (keyof G)[], world: MergeableWorld<G, unknown, unknown>) => { [key in keyof G]: G[key]; };
3
+ export declare const requireFromWhen: <W>(keys: (keyof W)[], world: MergeableWorld<unknown, W, unknown>) => { [key in keyof W]: W[key]; };
4
+ export declare const requireFromThen: <T>(keys: (keyof T)[], world: MergeableWorld<unknown, unknown, T>) => { [key in keyof T]: T[key]; };
5
+ export declare const typeCoercer: (value: string) => string | number | boolean;
@@ -0,0 +1,72 @@
1
+ import { EmptyDependencies, EmptyObject, GetFunctionArgs, RequiredOrOptional } from "./builderTypeUtils";
2
+ export declare const whenBuilder: <GivenState, WhenState>() => {
3
+ statement: <Statement extends ((...args: [...any]) => string) | string>(statement: Statement) => {
4
+ dependencies: <GivenDeps extends RequiredOrOptional<GivenState>, WhenDeps extends RequiredOrOptional<WhenState>>(dependencies: {
5
+ given?: GivenDeps | undefined;
6
+ when?: WhenDeps | undefined;
7
+ }) => {
8
+ step: (stepFunction: (input: {
9
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
10
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
11
+ when: { [K_1 in keyof WhenState as K_1 extends keyof WhenDeps ? K_1 : never]: WhenDeps[K_1] extends "optional" ? WhenState[K_1] | undefined : WhenState[K_1]; };
12
+ then: never;
13
+ }) => Partial<WhenState>) => {
14
+ statement: Statement extends string ? () => string : Statement;
15
+ dependencies: {
16
+ given: GivenDeps;
17
+ when: WhenDeps;
18
+ then: EmptyObject;
19
+ };
20
+ stepType: "when";
21
+ stepFunction: (input: {
22
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
23
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
24
+ when: { [K_1 in keyof WhenState as K_1 extends keyof WhenDeps ? K_1 : never]: WhenDeps[K_1] extends "optional" ? WhenState[K_1] | undefined : WhenState[K_1]; };
25
+ then: never;
26
+ }) => Partial<WhenState>;
27
+ register: () => {
28
+ stepType: "when";
29
+ dependencies: {
30
+ given: GivenDeps;
31
+ when: WhenDeps;
32
+ then: EmptyObject;
33
+ };
34
+ statement: Statement extends string ? () => string : Statement;
35
+ stepFunction: (input: {
36
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
37
+ given: { [K in keyof GivenState as K extends keyof GivenDeps ? K : never]: GivenDeps[K] extends "optional" ? GivenState[K] | undefined : GivenState[K]; };
38
+ when: { [K_1 in keyof WhenState as K_1 extends keyof WhenDeps ? K_1 : never]: WhenDeps[K_1] extends "optional" ? WhenState[K_1] | undefined : WhenState[K_1]; };
39
+ then: never;
40
+ }) => Partial<WhenState>;
41
+ };
42
+ };
43
+ };
44
+ step: (stepFunction: (input: {
45
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
46
+ given: never;
47
+ when: never;
48
+ then: never;
49
+ }) => Partial<WhenState>) => {
50
+ statement: Statement extends string ? () => string : Statement;
51
+ dependencies: EmptyDependencies;
52
+ stepType: "when";
53
+ stepFunction: (input: {
54
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
55
+ given: never;
56
+ when: never;
57
+ then: never;
58
+ }) => Partial<WhenState>;
59
+ register: () => {
60
+ stepType: "when";
61
+ dependencies: EmptyDependencies;
62
+ statement: Statement extends string ? () => string : Statement;
63
+ stepFunction: (input: {
64
+ variables: Statement extends string ? [] : GetFunctionArgs<Statement>;
65
+ given: never;
66
+ when: never;
67
+ then: never;
68
+ }) => Partial<WhenState>;
69
+ };
70
+ };
71
+ };
72
+ };
@@ -0,0 +1,21 @@
1
+ export type WorldState<State> = {
2
+ readonly [K in keyof State]?: State[K];
3
+ };
4
+ export type MergeableWorldState<T> = WorldState<T> & {
5
+ merge: (newState: Partial<T>) => void;
6
+ };
7
+ export declare const createMergeableState: <T>(state: WorldState<T>) => MergeableWorldState<T>;
8
+ export type MergeableWorld<Given, When, Then> = {
9
+ given: MergeableWorldState<Given>;
10
+ when: MergeableWorldState<When>;
11
+ then: MergeableWorldState<Then>;
12
+ };
13
+ export declare class BasicWorld<Given, When, Then> {
14
+ private givenState;
15
+ private whenState;
16
+ private thenState;
17
+ get given(): MergeableWorldState<Given>;
18
+ get when(): MergeableWorldState<When>;
19
+ get then(): MergeableWorldState<Then>;
20
+ }
21
+ export declare const createBasicWorld: <Given, When, Then>() => MergeableWorld<Given, When, Then>;
package/package.json CHANGED
@@ -1,20 +1,21 @@
1
1
  {
2
2
  "name": "@step-forge/step-forge",
3
- "version": "0.0.5",
4
- "module": "./dist/step-forge.js",
3
+ "version": "0.0.7-beta",
5
4
  "type": "module",
6
5
  "exports": {
7
6
  ".": {
8
- "import": "./dist/step-forge.js"
9
- },
10
- "./dist/": {
11
- "import": "./dist/"
7
+ "types": "./dist/types/index.d.ts",
8
+ "import": "./dist/step-forge.js",
9
+ "default": "./dist/step-forge.js"
12
10
  }
13
11
  },
14
- "types": "./dist/index.d.ts",
12
+ "types": "./dist/types/index.d.ts",
13
+ "files": [
14
+ "dist"
15
+ ],
15
16
  "scripts": {
16
17
  "dev": "vite --host",
17
- "build": "rimraf build/**/* && tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts && copyfiles ./package.json build",
18
+ "build": "rimraf dist && tsc --emitDeclarationOnly --outDir dist/types && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts",
18
19
  "test:cucumber": "NODE_ENV=test NODE_OPTIONS=\"--experimental-specifier-resolution=node --loader ts-node/esm\" TS_NODE_PROJECT=./tsconfig.cucumber.json cucumber-js -p default",
19
20
  "test:ci": "NODE_ENV=test cucumber-js -p ci",
20
21
  "test": "NODE_ENV=test PORT=7888 LOG_LEVEL=none cucumber-js -p all 2> /dev/null",
package/.eslintignore DELETED
@@ -1,6 +0,0 @@
1
- .history
2
- .husky
3
- .vscode
4
- coverage
5
- dist
6
- node_modules
package/.eslintrc DELETED
@@ -1,18 +0,0 @@
1
- {
2
- "root": true,
3
- "parser": "@typescript-eslint/parser",
4
- "plugins": ["@typescript-eslint", "prettier"],
5
- "extends": [
6
- "eslint:recommended",
7
- "plugin:@typescript-eslint/eslint-recommended",
8
- "plugin:@typescript-eslint/recommended",
9
- "prettier"
10
- ],
11
- "env": {
12
- "browser": true,
13
- "node": true
14
- },
15
- "rules": {
16
- "prettier/prettier": "error"
17
- }
18
- }
package/.prettierignore DELETED
@@ -1,6 +0,0 @@
1
- .history
2
- .husky
3
- .vscode
4
- coverage
5
- dist
6
- node_modules
package/.prettierrc DELETED
@@ -1,15 +0,0 @@
1
- {
2
- "printWidth": 80,
3
- "tabWidth": 2,
4
- "singleQuote": false,
5
- "trailingComma": "es5",
6
- "arrowParens": "avoid",
7
- "bracketSpacing": true,
8
- "useTabs": false,
9
- "endOfLine": "auto",
10
- "singleAttributePerLine": false,
11
- "bracketSameLine": false,
12
- "jsxSingleQuote": false,
13
- "quoteProps": "as-needed",
14
- "semi": true
15
- }
package/CHANGELOG.md DELETED
@@ -1,28 +0,0 @@
1
- # Change Log
2
-
3
- All notable changes to the "@step-forge/step-forge" project will be documented in this file.
4
-
5
- ## [0.0.5] - 2024-12-31
6
-
7
- - Add support for exporting steps
8
-
9
- ## [0.0.4] - 2024-07-30
10
-
11
- - Update all packages to the latest versions
12
- - Remove support for CommonJS modules
13
-
14
- ## [0.0.3] - 2024-01-23
15
-
16
- - Update all packages to the latest versions (update to vite 5.x)
17
-
18
- ## [0.0.2] - 2023-01-18
19
-
20
- - Update all packages to the latest versions (update to vite 4.x)
21
-
22
- ## [0.0.1] - 2022-09-08
23
-
24
- - Update all packages to the latest versions (update to vite 3.x)
25
-
26
- ## [0.0.0] - 2022-03-28
27
-
28
- - Initial release
package/cucumber.mjs DELETED
@@ -1,38 +0,0 @@
1
- const defaultProfile = {
2
- format: [
3
- process.env.CI || !process.stdout.isTTY ? "progress" : "progress-bar",
4
- "json:./reports/cucumber-json-reports/report.json",
5
- "rerun:./reports/cucumber/@rerun.txt",
6
- "usage:./reports/cucumber/usage.txt",
7
- ],
8
- parallel: 1,
9
- importModule: ["ts-node/esm", "tsconfig-paths/register"],
10
- import: [
11
- "./features/steps/**/*.ts",
12
- "./features/steps/*.ts",
13
- "./src/**/*.ts",
14
- ],
15
- strict: false,
16
- };
17
-
18
- const ciProfile = {
19
- format: [
20
- process.env.CI || !process.stdout.isTTY ? "progress" : "progress-bar",
21
- "json:./reports/cucumber-json-reports/report.json",
22
- "rerun:./reports/cucumber/@rerun.txt",
23
- "usage:./reports/cucumber/usage.txt",
24
- ],
25
- parallel: 1,
26
- importModule: ["ts-node/register/transpile-only", "tsconfig-paths/register"],
27
- import: ["./features/steps/**/*.ts", "./features/steps/*.ts"],
28
- strict: false,
29
- publish: true,
30
- };
31
-
32
- const all = {
33
- ...defaultProfile,
34
- paths: ["./features"],
35
- };
36
-
37
- export { ciProfile as ci, all };
38
- export default defaultProfile;
Binary file
@@ -1,11 +0,0 @@
1
- const config = {
2
- entries: [
3
- {
4
- filePath: "./src/index.ts",
5
- outFile: "./build/dist/index.d.ts",
6
- noCheck: false,
7
- },
8
- ],
9
- };
10
-
11
- module.exports = config;
@@ -1,21 +0,0 @@
1
- Feature: Steps written in gherkin can be matched to Step Forge steps
2
-
3
- Scenario: Basic feature steps with no dependencies or variables can be run as a cucumber scenario
4
- Given I started
5
- When I got here
6
- Then everything was good
7
-
8
- Scenario: Basic feature steps with dependencies can be run as a cucumber scenario
9
- Given a user
10
- When I save the user
11
- Then there is a user
12
-
13
- Scenario: Basic feature steps with variables can be run as a cucumber scenario
14
- Given a user named "John"
15
- When I save the user
16
- Then there is a user
17
-
18
- Scenario: Basic feature steps with dependencies and variables can be run as a cucumber scenario
19
- Given a user
20
- When I name the user "John"
21
- Then the user's name is "John"
@@ -1,6 +0,0 @@
1
- Feature: Builders can be re-exported for ease of use
2
-
3
- Scenario: Exported steps can be used in cucumber scenarios
4
- Given a bank user
5
- When I deposit "1000" "USD"
6
- Then the balance is "1000"
@@ -1,93 +0,0 @@
1
- import { givenBuilder } from "../../src/given";
2
- import { whenBuilder } from "../../src/when";
3
- import { thenBuilder } from "../../src/then";
4
- import { GivenState, ThenState, WhenState } from "./world";
5
- import { expect } from "earl";
6
-
7
- // --- No dependency no variable steps --- //
8
- givenBuilder<GivenState>()
9
- .statement("I started")
10
- .step(() => ({}))
11
- .register();
12
-
13
- whenBuilder<GivenState, WhenState>()
14
- .statement("I got here")
15
- .step(() => ({}))
16
- .register();
17
-
18
- thenBuilder<GivenState, WhenState, ThenState>()
19
- .statement("everything was good")
20
- .step(() => ({}))
21
- .register();
22
-
23
- // --- Dependency only steps --- //
24
- givenBuilder<GivenState>()
25
- .statement("a user")
26
- .step(() => {
27
- return {
28
- user: {
29
- type: "person",
30
- token: "random",
31
- },
32
- };
33
- })
34
- .register();
35
-
36
- whenBuilder<GivenState, WhenState>()
37
- .statement("I save the user")
38
- .dependencies({ given: { user: "required" } })
39
- .step(({ given: { user } }) => {
40
- return {
41
- user: {
42
- ...user,
43
- saved: true,
44
- },
45
- };
46
- })
47
- .register();
48
-
49
- thenBuilder<GivenState, WhenState, ThenState>()
50
- .statement("there is a user")
51
- .dependencies({ when: { user: "required" } })
52
- .step(({ when: { user } }) => {
53
- expect(user.saved).toBeTruthy();
54
- })
55
- .register();
56
-
57
- // --- Variable only steps --- //
58
- givenBuilder<GivenState>()
59
- .statement((userName: string) => `a user named ${userName}`)
60
- .step(({ variables: [userName] }) => {
61
- return {
62
- user: {
63
- type: "person",
64
- token: userName,
65
- },
66
- };
67
- })
68
- .register();
69
-
70
- // --- More complex steps --- //
71
-
72
- whenBuilder<GivenState, WhenState>()
73
- .statement((userName: string) => `I name the user ${userName}`)
74
- .dependencies({ given: { user: "required" } })
75
- .step(({ given: { user }, variables: [userName] }) => {
76
- return {
77
- user: {
78
- ...user,
79
- token: userName,
80
- saved: true,
81
- },
82
- };
83
- })
84
- .register();
85
-
86
- thenBuilder<GivenState, WhenState, ThenState>()
87
- .statement((userName: string) => `the user's name is ${userName}`)
88
- .dependencies({ when: { user: "required" } })
89
- .step(({ when: { user }, variables: [userName] }) => {
90
- const token = user.token;
91
- expect(token).toEqual(userName);
92
- })
93
- .register();
@@ -1,42 +0,0 @@
1
- import { expect } from "earl";
2
- import { givenBuilder } from "../../src/given";
3
- import { thenBuilder } from "../../src/then";
4
- import { whenBuilder } from "../../src/when";
5
- import { GivenState, ThenState, WhenState } from "./world";
6
-
7
- const Given = givenBuilder<GivenState>().statement;
8
- const When = whenBuilder<GivenState, WhenState>().statement;
9
- const Then = thenBuilder<GivenState, WhenState, ThenState>().statement;
10
-
11
- Given("a bank user")
12
- .step(() => {
13
- return {
14
- user: {
15
- type: "customer",
16
- token: "random",
17
- },
18
- };
19
- })
20
- .register();
21
-
22
- When((amount: string, currency: string) => `I deposit ${amount} ${currency}`)
23
- .dependencies({ given: { user: "required" } })
24
- .step(({ variables: [rawAmount, currency], given: { user } }) => {
25
- const amount = parseFloat(rawAmount);
26
- return {
27
- deposit: {
28
- amount,
29
- currency,
30
- user,
31
- },
32
- };
33
- })
34
- .register();
35
-
36
- Then((amount: string) => `the balance is ${amount}`)
37
- .dependencies({ when: { deposit: "required" } })
38
- .step(({ when: { deposit }, variables: [rawAmount] }) => {
39
- const amount = parseFloat(rawAmount);
40
- expect(deposit.amount).toEqual(amount);
41
- })
42
- .register();
@@ -1,29 +0,0 @@
1
- import { setWorldConstructor } from "@cucumber/cucumber";
2
- import { BasicWorld } from "../../src/world";
3
-
4
- export interface GivenState {
5
- user: {
6
- type: string;
7
- token: string;
8
- };
9
- }
10
-
11
- export interface WhenState {
12
- user: {
13
- type: string;
14
- token: string;
15
- saved: boolean;
16
- };
17
- deposit: {
18
- amount: number;
19
- currency: string;
20
- user: {
21
- type: string;
22
- token: string;
23
- };
24
- };
25
- }
26
-
27
- export interface ThenState {}
28
-
29
- setWorldConstructor(BasicWorld<GivenState, WhenState, ThenState>);