pickle-jar 1.0.2 → 1.0.3

package/dist/types/src/grammar/GherkinParserVisitor.d.ts

@@ -0,0 +1,150 @@
+import { ParseTreeVisitor } from "antlr4ts/tree/ParseTreeVisitor";
+import { FeatureFileContext } from "./GherkinParser";
+import { FeatureContext } from "./GherkinParser";
+import { BackgroundContext } from "./GherkinParser";
+import { ScenarioContext } from "./GherkinParser";
+import { ScenarioOutlineContext } from "./GherkinParser";
+import { ExamplesBlockContext } from "./GherkinParser";
+import { TableHeaderContext } from "./GherkinParser";
+import { TableRowContext } from "./GherkinParser";
+import { CellContext } from "./GherkinParser";
+import { StepContext } from "./GherkinParser";
+import { GivenStepContext } from "./GherkinParser";
+import { AndGivenStepContext } from "./GherkinParser";
+import { WhenStepContext } from "./GherkinParser";
+import { AndWhenStepContext } from "./GherkinParser";
+import { ThenStepContext } from "./GherkinParser";
+import { AndStepContext } from "./GherkinParser";
+import { ButStepContext } from "./GherkinParser";
+import { DocStringContext } from "./GherkinParser";
+import { TagsContext } from "./GherkinParser";
+import { ContentTextContext } from "./GherkinParser";
+/**
+ * This interface defines a complete generic visitor for a parse tree produced
+ * by `GherkinParser`.
+ *
+ * @param <Result> The return type of the visit operation. Use `void` for
+ * operations with no return type.
+ */
+export interface GherkinParserVisitor<Result> extends ParseTreeVisitor<Result> {
+    /**
+     * Visit a parse tree produced by `GherkinParser.featureFile`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitFeatureFile?: (ctx: FeatureFileContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.feature`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitFeature?: (ctx: FeatureContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.background`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitBackground?: (ctx: BackgroundContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.scenario`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitScenario?: (ctx: ScenarioContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.scenarioOutline`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitScenarioOutline?: (ctx: ScenarioOutlineContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.examplesBlock`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitExamplesBlock?: (ctx: ExamplesBlockContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.tableHeader`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitTableHeader?: (ctx: TableHeaderContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.tableRow`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitTableRow?: (ctx: TableRowContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.cell`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitCell?: (ctx: CellContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.step`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitStep?: (ctx: StepContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.givenStep`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitGivenStep?: (ctx: GivenStepContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.andGivenStep`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitAndGivenStep?: (ctx: AndGivenStepContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.whenStep`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitWhenStep?: (ctx: WhenStepContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.andWhenStep`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitAndWhenStep?: (ctx: AndWhenStepContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.thenStep`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitThenStep?: (ctx: ThenStepContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.andStep`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitAndStep?: (ctx: AndStepContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.butStep`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitButStep?: (ctx: ButStepContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.docString`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitDocString?: (ctx: DocStringContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.tags`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitTags?: (ctx: TagsContext) => Result;
+    /**
+     * Visit a parse tree produced by `GherkinParser.contentText`.
+     * @param ctx the parse tree
+     * @return the visitor result
+     */
+    visitContentText?: (ctx: ContentTextContext) => Result;
+}

package/dist/types/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./test-runner";
+export * from "./step-definition";
+export * from "./step";

package/dist/types/src/step-definition.d.ts

@@ -0,0 +1,5 @@
+import { Step } from "./step";
+export interface StepDefinition<TWorld> {
+    match: RegExp;
+    step: Step<TWorld>;
+}

package/dist/types/src/step.d.ts

@@ -0,0 +1 @@
+export type Step<TWorld> = (world: TWorld, ...params: string[]) => void;

package/dist/types/src/test-runner.d.ts

@@ -0,0 +1,2 @@
+import { StepDefinition } from "./step-definition";
+export declare function testRunner<TWorld>(globPattern: string, stepDefinitions: StepDefinition<TWorld>[], world: TWorld): void;

package/dist/types/test/runner.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "pickle-jar",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "main": "dist/src/index.js",
   "types": "dist/types/src/index.d.ts",
   "repository": "git@github0.com:nseba/pickle-jar.git",
   "author": "Sebastian Negomireanu",
   "license": "MIT",
+  "files": [
+    "dist/"
+  ],
   "devDependencies": {
     "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.1",

package/.eslintignore

@@ -1,4 +0,0 @@
-node_modules
-dist
-coverage
-src/grammar

package/.eslintrc

@@ -1,12 +0,0 @@
-{
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/eslint-recommended",
-      "plugin:@typescript-eslint/recommended"
-    ]
-  }

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/pickle-jar.iml" filepath="$PROJECT_DIR$/.idea/pickle-jar.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/pickle-jar.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>

package/Makefile

@@ -1,43 +0,0 @@
-.DEFAULT_GOAL := rebuild
-.PHONY: all build rebuild watch clean test test-prod test-watch lint start doc
-
-build:
-	npx tsc	
-	npx cpx "src/**/*{.jsx?, .css}" "dist/"
-
-rebuild:
-	$(MAKE) clean
-	$(MAKE) build
-
-watch:
-	$(MAKE) build
-	(trap 'kill 0' SIGINT; npx tsc-watch & npx cpx "src/**/*{.jsx?, .css}" "dist/" --watch)
-
-start:
-	$(MAKE) build
-	(trap 'kill 0' SIGINT; npx tsc-watch & npx cpx "src/**/*{.jsx?,.css}" "dist/" --watch & nodemon -r dotenv/config dist/bin/index.js)
-
-clean:
-	rm -rfv ./dist
-	rm -vf *.tsbuildinfo
-
-test:
-	npx jest
-
-test-prod:
-	npx jest --coverage --no-cache
-
-test-watch:
-	npx jest --watch
-
-lint:
-	npx eslint '*/**/*.{js,ts,tsx}' --fix
-
-grammar:
-	. ./grammar.sh
-
-all:
-	$(MAKE) clean
-	$(MAKE) build
-	$(MAKE) lint
-	$(MAKE) test