@dev-blinq/cucumber-js 1.0.0-amdocs

package/lib/api/run_cucumber.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCucumber = void 0;
+const messages_1 = require("@cucumber/messages");
+const events_1 = require("events");
+const helpers_1 = require("../cli/helpers");
+const helpers_2 = require("../formatter/helpers");
+const console_logger_1 = require("./console_logger");
+const environment_1 = require("./environment");
+const formatters_1 = require("./formatters");
+const gherkin_1 = require("./gherkin");
+const paths_1 = require("./paths");
+const plugins_1 = require("./plugins");
+const runtime_1 = require("./runtime");
+const support_1 = require("./support");
+/**
+ * Execute a Cucumber test run.
+ *
+ * @public
+ * @param configuration - Configuration loaded from `loadConfiguration`.
+ * @param environment - Project environment.
+ * @param onMessage - Callback fired each time Cucumber emits a message.
+ */
+async function runCucumber(configuration, environment = {}, onMessage) {
+    const { cwd, stdout, stderr, env, debug } = (0, environment_1.mergeEnvironment)(environment);
+    const logger = new console_logger_1.ConsoleLogger(stderr, debug);
+    const newId = messages_1.IdGenerator.uuid();
+    const supportCoordinates = 'World' in configuration.support
+        ? configuration.support.originalCoordinates
+        : configuration.support;
+    const { unexpandedFeaturePaths, featurePaths, requirePaths, importPaths } = await (0, paths_1.resolvePaths)(logger, cwd, configuration.sources, supportCoordinates);
+    const supportCodeLibrary = 'World' in configuration.support
+        ? configuration.support
+        : await (0, support_1.getSupportCodeLibrary)({
+            cwd,
+            newId,
+            requirePaths,
+            importPaths,
+            requireModules: supportCoordinates.requireModules,
+        });
+    const plugins = await (0, plugins_1.initializePlugins)(logger, configuration, environment);
+    const eventBroadcaster = new events_1.EventEmitter();
+    if (onMessage) {
+        eventBroadcaster.on('envelope', onMessage);
+    }
+    eventBroadcaster.on('envelope', (value) => plugins.emit('message', value));
+    const eventDataCollector = new helpers_2.EventDataCollector(eventBroadcaster);
+    let formatterStreamError = false;
+    const cleanupFormatters = await (0, formatters_1.initializeFormatters)({
+        env,
+        cwd,
+        stdout,
+        stderr,
+        logger,
+        onStreamError: () => (formatterStreamError = true),
+        eventBroadcaster,
+        eventDataCollector,
+        configuration: configuration.formats,
+        supportCodeLibrary,
+    });
+    await (0, helpers_1.emitMetaMessage)(eventBroadcaster, env, configuration.runName);
+    let pickleIds = [];
+    let parseErrors = [];
+    if (featurePaths.length > 0) {
+        const gherkinResult = await (0, gherkin_1.getFilteredPicklesAndErrors)({
+            newId,
+            cwd,
+            logger,
+            unexpandedFeaturePaths,
+            featurePaths,
+            coordinates: configuration.sources,
+            onEnvelope: (envelope) => eventBroadcaster.emit('envelope', envelope),
+        });
+        pickleIds = gherkinResult.filteredPickles.map(({ pickle }) => pickle.id);
+        parseErrors = gherkinResult.parseErrors;
+    }
+    if (parseErrors.length) {
+        parseErrors.forEach((parseError) => {
+            logger.error(`Parse error in "${parseError.source.uri}" ${parseError.message}`);
+        });
+        await cleanupFormatters();
+        await plugins.cleanup();
+        return {
+            success: false,
+            support: supportCodeLibrary,
+        };
+    }
+    (0, helpers_1.emitSupportCodeMessages)({
+        eventBroadcaster,
+        supportCodeLibrary,
+        newId,
+    });
+    const runtime = (0, runtime_1.makeRuntime)({
+        cwd,
+        logger,
+        eventBroadcaster,
+        eventDataCollector,
+        pickleIds,
+        newId,
+        supportCodeLibrary,
+        requireModules: supportCoordinates.requireModules,
+        requirePaths,
+        importPaths,
+        options: configuration.runtime,
+    });
+    const success = await runtime.start();
+    await cleanupFormatters();
+    await plugins.cleanup();
+    return {
+        success: success && !formatterStreamError,
+        support: supportCodeLibrary,
+    };
+}
+exports.runCucumber = runCucumber;
+//# sourceMappingURL=run_cucumber.js.map

package/lib/api/run_cucumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run_cucumber.js","sourceRoot":"","sources":["../../src/api/run_cucumber.ts"],"names":[],"mappings":";;;AAAA,iDAAsE;AACtE,mCAAqC;AACrC,4CAAyE;AACzE,kDAAyD;AAEzD,qDAAgD;AAChD,+CAAgD;AAChD,6CAAmD;AACnD,uCAAuD;AACvD,mCAAsC;AACtC,uCAA6C;AAC7C,uCAAuC;AACvC,uCAAiD;AAGjD;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,aAA0B,EAC1B,cAA+B,EAAE,EACjC,SAAuC;IAEvC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,IAAA,8BAAgB,EAAC,WAAW,CAAC,CAAA;IACzE,MAAM,MAAM,GAAY,IAAI,8BAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAExD,MAAM,KAAK,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAA;IAEhC,MAAM,kBAAkB,GACtB,OAAO,IAAI,aAAa,CAAC,OAAO;QAC9B,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,mBAAmB;QAC3C,CAAC,CAAC,aAAa,CAAC,OAAO,CAAA;IAE3B,MAAM,EAAE,sBAAsB,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,GACvE,MAAM,IAAA,oBAAY,EAAC,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IAE5E,MAAM,kBAAkB,GACtB,OAAO,IAAI,aAAa,CAAC,OAAO;QAC9B,CAAC,CAAC,aAAa,CAAC,OAAO;QACvB,CAAC,CAAC,MAAM,IAAA,+BAAqB,EAAC;YAC1B,GAAG;YACH,KAAK;YACL,YAAY;YACZ,WAAW;YACX,cAAc,EAAE,kBAAkB,CAAC,cAAc;SAClD,CAAC,CAAA;IAER,MAAM,OAAO,GAAG,MAAM,IAAA,2BAAiB,EAAC,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;IAE3E,MAAM,gBAAgB,GAAG,IAAI,qBAAY,EAAE,CAAA;IAC3C,IAAI,SAAS,EAAE;QACb,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;KAC3C;IACD,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAA;IAC1E,MAAM,kBAAkB,GAAG,IAAI,4BAAkB,CAAC,gBAAgB,CAAC,CAAA;IAEnE,IAAI,oBAAoB,GAAG,KAAK,CAAA;IAChC,MAAM,iBAAiB,GAAG,MAAM,IAAA,iCAAoB,EAAC;QACnD,GAAG;QACH,GAAG;QACH,MAAM;QACN,MAAM;QACN,MAAM;QACN,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAClD,gBAAgB;QAChB,kBAAkB;QAClB,aAAa,EAAE,aAAa,CAAC,OAAO;QACpC,kBAAkB;KACnB,CAAC,CAAA;IACF,MAAM,IAAA,yBAAe,EAAC,gBAAgB,EAAE,GAAG,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;IAEnE,IAAI,SAAS,GAAa,EAAE,CAAA;IAC5B,IAAI,WAAW,GAAiB,EAAE,CAAA;IAClC,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3B,MAAM,aAAa,GAAG,MAAM,IAAA,qCAA2B,EAAC;YACtD,KAAK;YACL,GAAG;YACH,MAAM;YACN,sBAAsB;YACtB,YAAY;YACZ,WAAW,EAAE,aAAa,CAAC,OAAO;YAClC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;SACtE,CAAC,CAAA;QACF,SAAS,GAAG,aAAa,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QACxE,WAAW,GAAG,aAAa,CAAC,WAAW,CAAA;KACxC;IACD,IAAI,WAAW,CAAC,MAAM,EAAE;QACtB,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACjC,MAAM,CAAC,KAAK,CACV,mBAAmB,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,CAClE,CAAA;QACH,CAAC,CAAC,CAAA;QACF,MAAM,iBAAiB,EAAE,CAAA;QACzB,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;QACvB,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kBAAkB;SAC5B,CAAA;KACF;IAED,IAAA,iCAAuB,EAAC;QACtB,gBAAgB;QAChB,kBAAkB;QAClB,KAAK;KACN,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,GAAG;QACH,MAAM;QACN,gBAAgB;QAChB,kBAAkB;QAClB,SAAS;QACT,KAAK;QACL,kBAAkB;QAClB,cAAc,EAAE,kBAAkB,CAAC,cAAc;QACjD,YAAY;QACZ,WAAW;QACX,OAAO,EAAE,aAAa,CAAC,OAAO;KAC/B,CAAC,CAAA;IACF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IACrC,MAAM,iBAAiB,EAAE,CAAA;IACzB,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;IAEvB,OAAO;QACL,OAAO,EAAE,OAAO,IAAI,CAAC,oBAAoB;QACzC,OAAO,EAAE,kBAAkB;KAC5B,CAAA;AACH,CAAC;AA7GD,kCA6GC","sourcesContent":["import { Envelope, IdGenerator, ParseError } from '@cucumber/messages'\nimport { EventEmitter } from 'events'\nimport { emitMetaMessage, emitSupportCodeMessages } from '../cli/helpers'\nimport { EventDataCollector } from '../formatter/helpers'\nimport { ILogger } from '../logger'\nimport { ConsoleLogger } from './console_logger'\nimport { mergeEnvironment } from './environment'\nimport { initializeFormatters } from './formatters'\nimport { getFilteredPicklesAndErrors } from './gherkin'\nimport { resolvePaths } from './paths'\nimport { initializePlugins } from './plugins'\nimport { makeRuntime } from './runtime'\nimport { getSupportCodeLibrary } from './support'\nimport { IRunEnvironment, IRunOptions, IRunResult } from './types'\n\n/**\n * Execute a Cucumber test run.\n *\n * @public\n * @param configuration - Configuration loaded from `loadConfiguration`.\n * @param environment - Project environment.\n * @param onMessage - Callback fired each time Cucumber emits a message.\n */\nexport async function runCucumber(\n  configuration: IRunOptions,\n  environment: IRunEnvironment = {},\n  onMessage?: (message: Envelope) => void\n): Promise<IRunResult> {\n  const { cwd, stdout, stderr, env, debug } = mergeEnvironment(environment)\n  const logger: ILogger = new ConsoleLogger(stderr, debug)\n\n  const newId = IdGenerator.uuid()\n\n  const supportCoordinates =\n    'World' in configuration.support\n      ? configuration.support.originalCoordinates\n      : configuration.support\n\n  const { unexpandedFeaturePaths, featurePaths, requirePaths, importPaths } =\n    await resolvePaths(logger, cwd, configuration.sources, supportCoordinates)\n\n  const supportCodeLibrary =\n    'World' in configuration.support\n      ? configuration.support\n      : await getSupportCodeLibrary({\n          cwd,\n          newId,\n          requirePaths,\n          importPaths,\n          requireModules: supportCoordinates.requireModules,\n        })\n\n  const plugins = await initializePlugins(logger, configuration, environment)\n\n  const eventBroadcaster = new EventEmitter()\n  if (onMessage) {\n    eventBroadcaster.on('envelope', onMessage)\n  }\n  eventBroadcaster.on('envelope', (value) => plugins.emit('message', value))\n  const eventDataCollector = new EventDataCollector(eventBroadcaster)\n\n  let formatterStreamError = false\n  const cleanupFormatters = await initializeFormatters({\n    env,\n    cwd,\n    stdout,\n    stderr,\n    logger,\n    onStreamError: () => (formatterStreamError = true),\n    eventBroadcaster,\n    eventDataCollector,\n    configuration: configuration.formats,\n    supportCodeLibrary,\n  })\n  await emitMetaMessage(eventBroadcaster, env, configuration.runName)\n\n  let pickleIds: string[] = []\n  let parseErrors: ParseError[] = []\n  if (featurePaths.length > 0) {\n    const gherkinResult = await getFilteredPicklesAndErrors({\n      newId,\n      cwd,\n      logger,\n      unexpandedFeaturePaths,\n      featurePaths,\n      coordinates: configuration.sources,\n      onEnvelope: (envelope) => eventBroadcaster.emit('envelope', envelope),\n    })\n    pickleIds = gherkinResult.filteredPickles.map(({ pickle }) => pickle.id)\n    parseErrors = gherkinResult.parseErrors\n  }\n  if (parseErrors.length) {\n    parseErrors.forEach((parseError) => {\n      logger.error(\n        `Parse error in \"${parseError.source.uri}\" ${parseError.message}`\n      )\n    })\n    await cleanupFormatters()\n    await plugins.cleanup()\n    return {\n      success: false,\n      support: supportCodeLibrary,\n    }\n  }\n\n  emitSupportCodeMessages({\n    eventBroadcaster,\n    supportCodeLibrary,\n    newId,\n  })\n\n  const runtime = makeRuntime({\n    cwd,\n    logger,\n    eventBroadcaster,\n    eventDataCollector,\n    pickleIds,\n    newId,\n    supportCodeLibrary,\n    requireModules: supportCoordinates.requireModules,\n    requirePaths,\n    importPaths,\n    options: configuration.runtime,\n  })\n  const success = await runtime.start()\n  await cleanupFormatters()\n  await plugins.cleanup()\n\n  return {\n    success: success && !formatterStreamError,\n    support: supportCodeLibrary,\n  }\n}\n"]}

package/lib/api/runtime.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import { IRuntime } from '../runtime';
+import { EventEmitter } from 'events';
+import { EventDataCollector } from '../formatter/helpers';
+import { IdGenerator } from '@cucumber/messages';
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+import { IRunOptionsRuntime } from './types';
+import { ILogger } from '../logger';
+export declare function makeRuntime({ cwd, logger, eventBroadcaster, eventDataCollector, pickleIds, newId, supportCodeLibrary, requireModules, requirePaths, importPaths, options: { parallel, ...options }, }: {
+    cwd: string;
+    logger: ILogger;
+    eventBroadcaster: EventEmitter;
+    eventDataCollector: EventDataCollector;
+    newId: IdGenerator.NewId;
+    pickleIds: string[];
+    supportCodeLibrary: ISupportCodeLibrary;
+    requireModules: string[];
+    requirePaths: string[];
+    importPaths: string[];
+    options: IRunOptionsRuntime;
+}): IRuntime;

package/lib/api/runtime.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeRuntime = void 0;
+const runtime_1 = __importDefault(require("../runtime"));
+const coordinator_1 = __importDefault(require("../runtime/parallel/coordinator"));
+function makeRuntime({ cwd, logger, eventBroadcaster, eventDataCollector, pickleIds, newId, supportCodeLibrary, requireModules, requirePaths, importPaths, options: { parallel, ...options }, }) {
+    if (parallel > 0) {
+        return new coordinator_1.default({
+            cwd,
+            logger,
+            eventBroadcaster,
+            eventDataCollector,
+            pickleIds,
+            options,
+            newId,
+            supportCodeLibrary,
+            requireModules,
+            requirePaths,
+            importPaths,
+            numberOfWorkers: parallel,
+        });
+    }
+    return new runtime_1.default({
+        eventBroadcaster,
+        eventDataCollector,
+        newId,
+        pickleIds,
+        supportCodeLibrary,
+        options,
+    });
+}
+exports.makeRuntime = makeRuntime;
+//# sourceMappingURL=runtime.js.map

package/lib/api/runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../../src/api/runtime.ts"],"names":[],"mappings":";;;;;;AAAA,yDAA8C;AAK9C,kFAAyD;AAIzD,SAAgB,WAAW,CAAC,EAC1B,GAAG,EACH,MAAM,EACN,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,EACT,KAAK,EACL,kBAAkB,EAClB,cAAc,EACd,YAAY,EACZ,WAAW,EACX,OAAO,EAAE,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,GAalC;IACC,IAAI,QAAQ,GAAG,CAAC,EAAE;QAChB,OAAO,IAAI,qBAAW,CAAC;YACrB,GAAG;YACH,MAAM;YACN,gBAAgB;YAChB,kBAAkB;YAClB,SAAS;YACT,OAAO;YACP,KAAK;YACL,kBAAkB;YAClB,cAAc;YACd,YAAY;YACZ,WAAW;YACX,eAAe,EAAE,QAAQ;SAC1B,CAAC,CAAA;KACH;IACD,OAAO,IAAI,iBAAO,CAAC;QACjB,gBAAgB;QAChB,kBAAkB;QAClB,KAAK;QACL,SAAS;QACT,kBAAkB;QAClB,OAAO;KACR,CAAC,CAAA;AACJ,CAAC;AAjDD,kCAiDC","sourcesContent":["import Runtime, { IRuntime } from '../runtime'\nimport { EventEmitter } from 'events'\nimport { EventDataCollector } from '../formatter/helpers'\nimport { IdGenerator } from '@cucumber/messages'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport Coordinator from '../runtime/parallel/coordinator'\nimport { IRunOptionsRuntime } from './types'\nimport { ILogger } from '../logger'\n\nexport function makeRuntime({\n  cwd,\n  logger,\n  eventBroadcaster,\n  eventDataCollector,\n  pickleIds,\n  newId,\n  supportCodeLibrary,\n  requireModules,\n  requirePaths,\n  importPaths,\n  options: { parallel, ...options },\n}: {\n  cwd: string\n  logger: ILogger\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  newId: IdGenerator.NewId\n  pickleIds: string[]\n  supportCodeLibrary: ISupportCodeLibrary\n  requireModules: string[]\n  requirePaths: string[]\n  importPaths: string[]\n  options: IRunOptionsRuntime\n}): IRuntime {\n  if (parallel > 0) {\n    return new Coordinator({\n      cwd,\n      logger,\n      eventBroadcaster,\n      eventDataCollector,\n      pickleIds,\n      options,\n      newId,\n      supportCodeLibrary,\n      requireModules,\n      requirePaths,\n      importPaths,\n      numberOfWorkers: parallel,\n    })\n  }\n  return new Runtime({\n    eventBroadcaster,\n    eventDataCollector,\n    newId,\n    pickleIds,\n    supportCodeLibrary,\n    options,\n  })\n}\n"]}

package/lib/api/support.d.ts

@@ -0,0 +1,9 @@
+import { IdGenerator } from '@cucumber/messages';
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+export declare function getSupportCodeLibrary({ cwd, newId, requireModules, requirePaths, importPaths, }: {
+    cwd: string;
+    newId: IdGenerator.NewId;
+    requireModules: string[];
+    requirePaths: string[];
+    importPaths: string[];
+}): Promise<ISupportCodeLibrary>;

package/lib/api/support.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSupportCodeLibrary = void 0;
+const support_code_library_builder_1 = __importDefault(require("../support_code_library_builder"));
+const url_1 = require("url");
+const try_require_1 = __importDefault(require("../try_require"));
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { importer } = require('../importer');
+async function getSupportCodeLibrary({ cwd, newId, requireModules, requirePaths, importPaths, }) {
+    support_code_library_builder_1.default.reset(cwd, newId, {
+        requireModules,
+        requirePaths,
+        importPaths,
+    });
+    requireModules.map((module) => (0, try_require_1.default)(module));
+    requirePaths.map((path) => (0, try_require_1.default)(path));
+    for (const path of importPaths) {
+        await importer((0, url_1.pathToFileURL)(path));
+    }
+    return support_code_library_builder_1.default.finalize();
+}
+exports.getSupportCodeLibrary = getSupportCodeLibrary;
+//# sourceMappingURL=support.js.map

package/lib/api/support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"support.js","sourceRoot":"","sources":["../../src/api/support.ts"],"names":[],"mappings":";;;;;;AAEA,mGAAuE;AACvE,6BAAmC;AACnC,iEAAuC;AAEvC,8DAA8D;AAC9D,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;AAEpC,KAAK,UAAU,qBAAqB,CAAC,EAC1C,GAAG,EACH,KAAK,EACL,cAAc,EACd,YAAY,EACZ,WAAW,GAOZ;IACC,sCAAyB,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE;QAC1C,cAAc;QACd,YAAY;QACZ,WAAW;KACZ,CAAC,CAAA;IAEF,cAAc,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC,CAAA;IAClD,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,qBAAU,EAAC,IAAI,CAAC,CAAC,CAAA;IAE5C,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE;QAC9B,MAAM,QAAQ,CAAC,IAAA,mBAAa,EAAC,IAAI,CAAC,CAAC,CAAA;KACpC;IAED,OAAO,sCAAyB,CAAC,QAAQ,EAAE,CAAA;AAC7C,CAAC;AA3BD,sDA2BC","sourcesContent":["import { IdGenerator } from '@cucumber/messages'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport supportCodeLibraryBuilder from '../support_code_library_builder'\nimport { pathToFileURL } from 'url'\nimport tryRequire from '../try_require'\n\n// eslint-disable-next-line @typescript-eslint/no-var-requires\nconst { importer } = require('../importer')\n\nexport async function getSupportCodeLibrary({\n  cwd,\n  newId,\n  requireModules,\n  requirePaths,\n  importPaths,\n}: {\n  cwd: string\n  newId: IdGenerator.NewId\n  requireModules: string[]\n  requirePaths: string[]\n  importPaths: string[]\n}): Promise<ISupportCodeLibrary> {\n  supportCodeLibraryBuilder.reset(cwd, newId, {\n    requireModules,\n    requirePaths,\n    importPaths,\n  })\n\n  requireModules.map((module) => tryRequire(module))\n  requirePaths.map((path) => tryRequire(path))\n\n  for (const path of importPaths) {\n    await importer(pathToFileURL(path))\n  }\n\n  return supportCodeLibraryBuilder.finalize()\n}\n"]}

package/lib/api/test_helpers.d.ts

@@ -0,0 +1,3 @@
+import { IRunEnvironment } from './types';
+export declare function setupEnvironment(): Promise<Partial<IRunEnvironment>>;
+export declare function teardownEnvironment(environment: IRunEnvironment): Promise<void>;

package/lib/api/test_helpers.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.teardownEnvironment = exports.setupEnvironment = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("mz/fs"));
+const reindent_template_literals_1 = require("reindent-template-literals");
+const stream_1 = require("stream");
+const messages_1 = require("@cucumber/messages");
+const newId = messages_1.IdGenerator.uuid();
+async function setupEnvironment() {
+    const cwd = path_1.default.join(__dirname, '..', '..', 'tmp', `api_${newId()}`);
+    await fs_1.default.mkdir(path_1.default.join(cwd, 'features'), { recursive: true });
+    await fs_1.default.writeFile(path_1.default.join(cwd, 'features', 'test.feature'), (0, reindent_template_literals_1.reindent)(`Feature: test fixture
+      Scenario: one
+        Given a step
+        Then another step`));
+    await fs_1.default.writeFile(path_1.default.join(cwd, 'features', 'steps.ts'), (0, reindent_template_literals_1.reindent)(`import { Given, Then } from '../../../src'
+    Given('a step', function () {})
+    Then('another step', function () {})`));
+    await fs_1.default.writeFile(path_1.default.join(cwd, 'cucumber.mjs'), `export default {paths: ['features/test.feature'], requireModule: ['ts-node/register'], require: ['features/steps.ts']}`);
+    const stdout = new stream_1.PassThrough();
+    return { cwd, stdout };
+}
+exports.setupEnvironment = setupEnvironment;
+async function teardownEnvironment(environment) {
+    return new Promise((resolve) => {
+        fs_1.default.rm(environment.cwd, { recursive: true }, resolve);
+    }).then(() => {
+        environment.stdout.end();
+    });
+}
+exports.teardownEnvironment = teardownEnvironment;
+//# sourceMappingURL=test_helpers.js.map

package/lib/api/test_helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test_helpers.js","sourceRoot":"","sources":["../../src/api/test_helpers.ts"],"names":[],"mappings":";;;;;;AACA,gDAAuB;AACvB,+CAAsB;AACtB,2EAAqD;AACrD,mCAAoC;AACpC,iDAAgD;AAEhD,MAAM,KAAK,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAA;AAEzB,KAAK,UAAU,gBAAgB;IACpC,MAAM,GAAG,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,KAAK,EAAE,EAAE,CAAC,CAAA;IACrE,MAAM,YAAE,CAAC,KAAK,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC/D,MAAM,YAAE,CAAC,SAAS,CAChB,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,cAAc,CAAC,EAC1C,IAAA,qCAAQ,EAAC;;;0BAGa,CAAC,CACxB,CAAA;IACD,MAAM,YAAE,CAAC,SAAS,CAChB,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,EACtC,IAAA,qCAAQ,EAAC;;yCAE4B,CAAC,CACvC,CAAA;IACD,MAAM,YAAE,CAAC,SAAS,CAChB,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,EAC9B,wHAAwH,CACzH,CAAA;IACD,MAAM,MAAM,GAAG,IAAI,oBAAW,EAAE,CAAA;IAChC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAA;AACxB,CAAC;AAtBD,4CAsBC;AAEM,KAAK,UAAU,mBAAmB,CAAC,WAA4B;IACpE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,YAAE,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAA;IACtD,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,CAAA;IAC1B,CAAC,CAAC,CAAA;AACJ,CAAC;AAND,kDAMC","sourcesContent":["import { IRunEnvironment } from './types'\nimport path from 'path'\nimport fs from 'mz/fs'\nimport { reindent } from 'reindent-template-literals'\nimport { PassThrough } from 'stream'\nimport { IdGenerator } from '@cucumber/messages'\n\nconst newId = IdGenerator.uuid()\n\nexport async function setupEnvironment(): Promise<Partial<IRunEnvironment>> {\n  const cwd = path.join(__dirname, '..', '..', 'tmp', `api_${newId()}`)\n  await fs.mkdir(path.join(cwd, 'features'), { recursive: true })\n  await fs.writeFile(\n    path.join(cwd, 'features', 'test.feature'),\n    reindent(`Feature: test fixture\n      Scenario: one\n        Given a step\n        Then another step`)\n  )\n  await fs.writeFile(\n    path.join(cwd, 'features', 'steps.ts'),\n    reindent(`import { Given, Then } from '../../../src'\n    Given('a step', function () {})\n    Then('another step', function () {})`)\n  )\n  await fs.writeFile(\n    path.join(cwd, 'cucumber.mjs'),\n    `export default {paths: ['features/test.feature'], requireModule: ['ts-node/register'], require: ['features/steps.ts']}`\n  )\n  const stdout = new PassThrough()\n  return { cwd, stdout }\n}\n\nexport async function teardownEnvironment(environment: IRunEnvironment) {\n  return new Promise((resolve) => {\n    fs.rm(environment.cwd, { recursive: true }, resolve)\n  }).then(() => {\n    environment.stdout.end()\n  })\n}\n"]}

package/lib/api/types.d.ts

@@ -0,0 +1,177 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Writable } from 'stream';
+import { IConfiguration } from '../configuration';
+import { FormatOptions, IPublishConfig } from '../formatter';
+import { PickleOrder } from '../models/pickle_order';
+import { IRuntimeOptions } from '../runtime';
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+/**
+ * @public
+ */
+export interface ILoadConfigurationOptions {
+    /**
+     * Path to load configuration file from (defaults to `cucumber.(js|cjs|mjs|json)` if omitted).
+     */
+    file?: string;
+    /**
+     * Zero or more profile names from which to source configuration (if omitted or empty, the `default` profile will be used).
+     */
+    profiles?: string[];
+    /**
+     * Ad-hoc configuration options to be applied over the top of whatever is loaded from the configuration file/profiles.
+     */
+    provided?: Partial<IConfiguration>;
+}
+/**
+ * @public
+ */
+export interface IResolvedConfiguration {
+    /**
+     * The final flat configuration object resolved from the configuration file/profiles plus any extra provided.
+     */
+    useConfiguration: IConfiguration;
+    /**
+     * The format that can be passed into `runCucumber`.
+     */
+    runConfiguration: IRunConfiguration;
+}
+/**
+ * @public
+ */
+export interface ISourcesCoordinates {
+    defaultDialect: string;
+    paths: string[];
+    names: string[];
+    tagExpression: string;
+    order: PickleOrder;
+}
+/**
+ * @public
+ */
+export interface IPlannedPickle {
+    name: string;
+    uri: string;
+    location: {
+        line: number;
+        column?: number;
+    };
+}
+/**
+ * @public
+ */
+export interface ISourcesError {
+    uri: string;
+    location: {
+        line: number;
+        column?: number;
+    };
+    message: string;
+}
+/**
+ * @public
+ */
+export interface ILoadSourcesResult {
+    plan: IPlannedPickle[];
+    errors: ISourcesError[];
+}
+/**
+ * @public
+ */
+export interface ISupportCodeCoordinates {
+    requireModules: string[];
+    requirePaths: string[];
+    importPaths: string[];
+}
+/**
+ * @public
+ */
+export interface ILoadSupportOptions {
+    sources: ISourcesCoordinates;
+    support: ISupportCodeCoordinates;
+}
+/**
+ * @public
+ */
+export interface IRunOptionsRuntime extends IRuntimeOptions {
+    parallel: number;
+}
+/**
+ * @public
+ */
+export interface IRunOptionsFormats {
+    stdout: string;
+    files: Record<string, string>;
+    publish: IPublishConfig | false;
+    options: FormatOptions;
+}
+/**
+ * @public
+ */
+export interface IRunConfiguration {
+    sources: ISourcesCoordinates;
+    support: ISupportCodeCoordinates;
+    runtime: IRunOptionsRuntime;
+    formats: IRunOptionsFormats;
+    runName?: string;
+}
+/**
+ * @public
+ */
+export type ISupportCodeCoordinatesOrLibrary = ISupportCodeCoordinates | ISupportCodeLibrary;
+/**
+ * @public
+ */
+export type { ISupportCodeLibrary };
+/**
+ * @public
+ */
+export interface IRunOptions {
+    sources: ISourcesCoordinates;
+    support: ISupportCodeCoordinatesOrLibrary;
+    runtime: IRunOptionsRuntime;
+    formats: IRunOptionsFormats;
+    runName?: string;
+}
+/**
+ * Contextual data about the project environment.
+ *
+ * @public
+ */
+export interface IRunEnvironment {
+    /**
+     * Working directory for the project (defaults to `process.cwd()` if omitted).
+     */
+    cwd?: string;
+    /**
+     * Writable stream where the test run's main output is written (defaults to `process.stdout` if omitted).
+     */
+    stdout?: Writable;
+    /**
+     * Writable stream where the test run's warning/error output is written (defaults to `process.stderr` if omitted).
+     */
+    stderr?: Writable;
+    /**
+     * Environment variables (defaults to `process.env` if omitted).
+     */
+    env?: NodeJS.ProcessEnv;
+    /**
+     * Whether debug logging is enabled.
+     */
+    debug?: boolean;
+}
+/**
+ * Result of a Cucumber test run.
+ *
+ * @public
+ */
+export interface IRunResult {
+    /**
+     * Whether the test run was overall successful i.e. no failed scenarios. The exact meaning can vary based on the `strict` configuration option.
+     */
+    success: boolean;
+    /**
+     * The support code library that was used in the test run; can be reused in subsequent `runCucumber` calls.
+     */
+    support: ISupportCodeLibrary;
+}

package/lib/api/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/api/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/api/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Writable } from 'stream'\nimport { IConfiguration } from '../configuration'\nimport { FormatOptions, IPublishConfig } from '../formatter'\nimport { PickleOrder } from '../models/pickle_order'\nimport { IRuntimeOptions } from '../runtime'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\n\n/**\n * @public\n */\nexport interface ILoadConfigurationOptions {\n  /**\n   * Path to load configuration file from (defaults to `cucumber.(js|cjs|mjs|json)` if omitted).\n   */\n  file?: string\n  /**\n   * Zero or more profile names from which to source configuration (if omitted or empty, the `default` profile will be used).\n   */\n  profiles?: string[]\n  /**\n   * Ad-hoc configuration options to be applied over the top of whatever is loaded from the configuration file/profiles.\n   */\n  provided?: Partial<IConfiguration>\n}\n\n/**\n * @public\n */\nexport interface IResolvedConfiguration {\n  /**\n   * The final flat configuration object resolved from the configuration file/profiles plus any extra provided.\n   */\n  useConfiguration: IConfiguration\n  /**\n   * The format that can be passed into `runCucumber`.\n   */\n  runConfiguration: IRunConfiguration\n}\n\n/**\n * @public\n */\nexport interface ISourcesCoordinates {\n  defaultDialect: string\n  paths: string[]\n  names: string[]\n  tagExpression: string\n  order: PickleOrder\n}\n\n/**\n * @public\n */\nexport interface IPlannedPickle {\n  name: string\n  uri: string\n  location: {\n    line: number\n    column?: number\n  }\n}\n\n/**\n * @public\n */\nexport interface ISourcesError {\n  uri: string\n  location: {\n    line: number\n    column?: number\n  }\n  message: string\n}\n\n/**\n * @public\n */\nexport interface ILoadSourcesResult {\n  plan: IPlannedPickle[]\n  errors: ISourcesError[]\n}\n\n/**\n * @public\n */\nexport interface ISupportCodeCoordinates {\n  requireModules: string[]\n  requirePaths: string[]\n  importPaths: string[]\n}\n\n/**\n * @public\n */\nexport interface ILoadSupportOptions {\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinates\n}\n\n/**\n * @public\n */\nexport interface IRunOptionsRuntime extends IRuntimeOptions {\n  parallel: number\n}\n\n/**\n * @public\n */\nexport interface IRunOptionsFormats {\n  stdout: string\n  files: Record<string, string>\n  publish: IPublishConfig | false\n  options: FormatOptions\n}\n\n/**\n * @public\n */\nexport interface IRunConfiguration {\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinates\n  runtime: IRunOptionsRuntime\n  formats: IRunOptionsFormats\n  runName?: string\n}\n\n/**\n * @public\n */\nexport type ISupportCodeCoordinatesOrLibrary =\n  | ISupportCodeCoordinates\n  | ISupportCodeLibrary\n\n/**\n * @public\n */\nexport type { ISupportCodeLibrary }\n\n/**\n * @public\n */\nexport interface IRunOptions {\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinatesOrLibrary\n  runtime: IRunOptionsRuntime\n  formats: IRunOptionsFormats\n  runName?: string\n}\n\n/**\n * Contextual data about the project environment.\n *\n * @public\n */\nexport interface IRunEnvironment {\n  /**\n   * Working directory for the project (defaults to `process.cwd()` if omitted).\n   */\n  cwd?: string\n  /**\n   * Writable stream where the test run's main output is written (defaults to `process.stdout` if omitted).\n   */\n  stdout?: Writable\n  /**\n   * Writable stream where the test run's warning/error output is written (defaults to `process.stderr` if omitted).\n   */\n  stderr?: Writable\n  /**\n   * Environment variables (defaults to `process.env` if omitted).\n   */\n  env?: NodeJS.ProcessEnv\n  /**\n   * Whether debug logging is enabled.\n   */\n  debug?: boolean\n}\n\n/**\n * Result of a Cucumber test run.\n *\n * @public\n */\nexport interface IRunResult {\n  /**\n   * Whether the test run was overall successful i.e. no failed scenarios. The exact meaning can vary based on the `strict` configuration option.\n   */\n  success: boolean\n  /**\n   * The support code library that was used in the test run; can be reused in subsequent `runCucumber` calls.\n   */\n  support: ISupportCodeLibrary\n}\n"]}

package/lib/api/wrapper.mjs

@@ -0,0 +1,6 @@
+import api from './index.js'
+
+export const loadConfiguration = api.loadConfiguration
+export const loadSupport = api.loadSupport
+export const loadSources = api.loadSources
+export const runCucumber = api.runCucumber

package/lib/cli/helpers.d.ts

@@ -0,0 +1,39 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { IdGenerator } from '@cucumber/messages';
+import { EventEmitter } from 'events';
+import { Readable } from 'stream';
+import { IConfiguration } from '../configuration';
+import { EventDataCollector } from '../formatter/helpers';
+import { ILogger } from '../logger';
+import { PickleOrder } from '../models/pickle_order';
+import PickleFilter from '../pickle_filter';
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+interface IParseGherkinMessageStreamRequest {
+    cwd?: string;
+    eventBroadcaster: EventEmitter;
+    eventDataCollector: EventDataCollector;
+    gherkinMessageStream: Readable;
+    order: string;
+    pickleFilter: PickleFilter;
+}
+/**
+ * Process a stream of envelopes from Gherkin and resolve to an array of filtered, ordered pickle Ids
+ *
+ * @param eventBroadcaster
+ * @param eventDataCollector
+ * @param gherkinMessageStream
+ * @param order
+ * @param pickleFilter
+ */
+export declare function parseGherkinMessageStream({ eventBroadcaster, eventDataCollector, gherkinMessageStream, order, pickleFilter, }: IParseGherkinMessageStreamRequest): Promise<string[]>;
+export declare function orderPickles<T = string>(pickleIds: T[], order: PickleOrder, logger: ILogger): void;
+export declare function emitMetaMessage(eventBroadcaster: EventEmitter, env: NodeJS.ProcessEnv, runName?: string): Promise<void>;
+export declare function emitSupportCodeMessages({ eventBroadcaster, supportCodeLibrary, newId, }: {
+    eventBroadcaster: EventEmitter;
+    supportCodeLibrary: ISupportCodeLibrary;
+    newId: IdGenerator.NewId;
+}): void;
+export declare function getRunName(argvConfiguration: Partial<IConfiguration>): string;
+export {};