@letsrunit/gherkin 0.1.0

package/README.md

@@ -0,0 +1,44 @@
+# Gherkin Package (`@letsrunit/gherkin`)
+
+## Installation
+
+```bash
+npm install @letsrunit/gherkin
+# or
+yarn add @letsrunit/gherkin
+```
+
+Utilities for parsing and manipulating Gherkin documents. It provides models and functions to work with features, scenarios, and steps.
+
+## Exported Functions
+
+### `makeFeature(feature)`
+
+Generates a formatted Gherkin string from a `Feature` object.
+
+- **`feature`**: An object containing `name`, `description`, `comments`, `background`, and `steps`.
+
+### `parseFeature(input)`
+
+Parses a Gherkin string (or just a list of steps) into a `Feature` object. It handles full features as well as partial scenarios.
+
+### `deltaSteps(steps, newSteps)`
+
+Calculates the difference between two sets of steps, returning only the `newSteps` that are not part of the trailing overlap of the original `steps`. Useful for iterative generation.
+
+### `sanitizeStepDefinition(expression)`
+
+Cleans up a step definition expression, removing leading keywords (Given, When, Then, etc.) and normalizing whitespace.
+
+## Exported Types
+
+- **`Feature`**: Interface representing a Gherkin feature.
+- **`ParameterTypeDefinition<T>`**: Interface for defining custom Cucumber parameter types.
+
+## Testing
+
+Run tests for this package:
+
+```bash
+yarn test
+```

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { Scalar } from '@letsrunit/utils';
+
+type Modifier = 'Control' | 'Shift' | 'Alt' | 'Meta';
+type Key = Modifier | 'Enter' | 'Escape' | 'Tab' | 'Backspace' | 'Delete' | 'Space' | 'ArrowUp' | 'ArrowDown' | 'ArrowLeft' | 'ArrowRight' | 'PageUp' | 'PageDown' | 'Home' | 'End' | `F${1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12}`;
+type KeyCombo = {
+    /** Modifiers pressed and held before the final key. */
+    modifiers: Modifier[];
+    /** The final key to press (e.g. 'Enter', 'S', 'ArrowUp', 'F5', etc.). */
+    key: Key | string;
+};
+
+interface ParameterTypeDefinition<T> {
+    name: string;
+    placeholder: string;
+    regexp: readonly RegExp[] | readonly string[] | RegExp | string;
+    transformer?: (...match: string[]) => T;
+    useForSnippets?: boolean;
+    preferForRegexpMatch?: boolean;
+}
+declare function booleanParameter(trueValue: string, falseValue: string, regexp?: RegExp): ParameterTypeDefinition<boolean>;
+declare function enumParameter<const T extends readonly string[]>(values: T, regexp?: RegExp): ParameterTypeDefinition<T[number]>;
+declare function valueParameter(name?: string): ParameterTypeDefinition<Scalar | Scalar[]>;
+declare function locatorParameter(name?: string): ParameterTypeDefinition<string>;
+declare function keysParameter(name?: string): ParameterTypeDefinition<KeyCombo>;
+
+interface Feature {
+    name?: string;
+    description?: string;
+    comments?: string;
+    background?: string[];
+    steps: string[];
+}
+declare function makeFeature({ name, description, comments, background, steps }: Feature): string;
+declare function parseFeature(input: string): Feature;
+declare function deltaSteps(steps: string[], newSteps: string[]): string[];
+
+declare function sanitizeStepDefinition<T extends string | RegExp>(step: T): T;
+
+export { type Feature, type KeyCombo, type ParameterTypeDefinition, booleanParameter, deltaSteps, enumParameter, keysParameter, locatorParameter, makeFeature, parseFeature, sanitizeStepDefinition, valueParameter };