@cucumber/cucumber 8.0.0-rc.1 → 8.0.0

package/lib/api/load_sources.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadSources = void 0;
+const paths_1 = require("./paths");
+const messages_1 = require("@cucumber/messages");
+const console_1 = require("console");
+const environment_1 = require("./environment");
+const gherkin_1 = require("./gherkin");
+/**
+ * Load and parse features, produce a filtered and ordered test plan and/or parse errors.
+ *
+ * @public
+ * @param coordinates - Coordinates required to find features
+ * @param environment - Project environment.
+ */
+async function loadSources(coordinates, environment = {}) {
+    const { cwd, stderr } = (0, environment_1.mergeEnvironment)(environment);
+    const logger = new console_1.Console(stderr);
+    const newId = messages_1.IdGenerator.uuid();
+    const { unexpandedFeaturePaths, featurePaths } = await (0, paths_1.resolvePaths)(cwd, coordinates);
+    if (featurePaths.length === 0) {
+        return {
+            plan: [],
+            errors: [],
+        };
+    }
+    const { filteredPickles, parseErrors } = await (0, gherkin_1.getFilteredPicklesAndErrors)({
+        newId,
+        cwd,
+        logger,
+        unexpandedFeaturePaths,
+        featurePaths,
+        coordinates,
+    });
+    const plan = filteredPickles.map(({ location, pickle }) => ({
+        name: pickle.name,
+        uri: pickle.uri,
+        location,
+    }));
+    const errors = parseErrors.map(({ source, message }) => {
+        return {
+            uri: source.uri,
+            location: source.location,
+            message,
+        };
+    });
+    return {
+        plan,
+        errors,
+    };
+}
+exports.loadSources = loadSources;
+//# sourceMappingURL=load_sources.js.map

package/lib/api/load_sources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load_sources.js","sourceRoot":"","sources":["../../src/api/load_sources.ts"],"names":[],"mappings":";;;AAOA,mCAAsC;AACtC,iDAAgD;AAChD,qCAAiC;AACjC,+CAAgD;AAChD,uCAAuD;AAEvD;;;;;;GAMG;AACI,KAAK,UAAU,WAAW,CAC/B,WAAgC,EAChC,cAA+B,EAAE;IAEjC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAA,8BAAgB,EAAC,WAAW,CAAC,CAAA;IACrD,MAAM,MAAM,GAAG,IAAI,iBAAO,CAAC,MAAM,CAAC,CAAA;IAClC,MAAM,KAAK,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAA;IAChC,MAAM,EAAE,sBAAsB,EAAE,YAAY,EAAE,GAAG,MAAM,IAAA,oBAAY,EACjE,GAAG,EACH,WAAW,CACZ,CAAA;IACD,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;QAC7B,OAAO;YACL,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,EAAE;SACX,CAAA;KACF;IACD,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,GAAG,MAAM,IAAA,qCAA2B,EAAC;QACzE,KAAK;QACL,GAAG;QACH,MAAM;QACN,sBAAsB;QACtB,YAAY;QACZ,WAAW;KACZ,CAAC,CAAA;IACF,MAAM,IAAI,GAAqB,eAAe,CAAC,GAAG,CAChD,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;QACzB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,QAAQ;KACT,CAAC,CACH,CAAA;IACD,MAAM,MAAM,GAAoB,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE;QACtE,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,OAAO;SACR,CAAA;IACH,CAAC,CAAC,CAAA;IACF,OAAO;QACL,IAAI;QACJ,MAAM;KACP,CAAA;AACH,CAAC;AA3CD,kCA2CC","sourcesContent":["import {\n  ILoadSourcesResult,\n  IPlannedPickle,\n  IRunEnvironment,\n  ISourcesCoordinates,\n  ISourcesError,\n} from './types'\nimport { resolvePaths } from './paths'\nimport { IdGenerator } from '@cucumber/messages'\nimport { Console } from 'console'\nimport { mergeEnvironment } from './environment'\nimport { getFilteredPicklesAndErrors } from './gherkin'\n\n/**\n * Load and parse features, produce a filtered and ordered test plan and/or parse errors.\n *\n * @public\n * @param coordinates - Coordinates required to find features\n * @param environment - Project environment.\n */\nexport async function loadSources(\n  coordinates: ISourcesCoordinates,\n  environment: IRunEnvironment = {}\n): Promise<ILoadSourcesResult> {\n  const { cwd, stderr } = mergeEnvironment(environment)\n  const logger = new Console(stderr)\n  const newId = IdGenerator.uuid()\n  const { unexpandedFeaturePaths, featurePaths } = await resolvePaths(\n    cwd,\n    coordinates\n  )\n  if (featurePaths.length === 0) {\n    return {\n      plan: [],\n      errors: [],\n    }\n  }\n  const { filteredPickles, parseErrors } = await getFilteredPicklesAndErrors({\n    newId,\n    cwd,\n    logger,\n    unexpandedFeaturePaths,\n    featurePaths,\n    coordinates,\n  })\n  const plan: IPlannedPickle[] = filteredPickles.map(\n    ({ location, pickle }) => ({\n      name: pickle.name,\n      uri: pickle.uri,\n      location,\n    })\n  )\n  const errors: ISourcesError[] = parseErrors.map(({ source, message }) => {\n    return {\n      uri: source.uri,\n      location: source.location,\n      message,\n    }\n  })\n  return {\n    plan,\n    errors,\n  }\n}\n"]}

package/lib/api/load_support.d.ts

@@ -0,0 +1,10 @@
+import { ILoadSupportOptions, IRunEnvironment } from './types';
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+/**
+ * Load support code for use in test runs.
+ *
+ * @public
+ * @param options - Subset of `IRunnableConfiguration` required to find the support code.
+ * @param environment - Project environment.
+ */
+export declare function loadSupport(options: ILoadSupportOptions, environment?: IRunEnvironment): Promise<ISupportCodeLibrary>;

package/lib/api/load_support.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadSupport = void 0;
+const messages_1 = require("@cucumber/messages");
+const paths_1 = require("./paths");
+const support_1 = require("./support");
+const environment_1 = require("./environment");
+/**
+ * Load support code for use in test runs.
+ *
+ * @public
+ * @param options - Subset of `IRunnableConfiguration` required to find the support code.
+ * @param environment - Project environment.
+ */
+async function loadSupport(options, environment = {}) {
+    const { cwd } = (0, environment_1.mergeEnvironment)(environment);
+    const newId = messages_1.IdGenerator.uuid();
+    const { requirePaths, importPaths } = await (0, paths_1.resolvePaths)(cwd, options.sources, options.support);
+    return await (0, support_1.getSupportCodeLibrary)({
+        cwd,
+        newId,
+        requireModules: options.support.requireModules,
+        requirePaths,
+        importPaths,
+    });
+}
+exports.loadSupport = loadSupport;
+//# sourceMappingURL=load_support.js.map

package/lib/api/load_support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load_support.js","sourceRoot":"","sources":["../../src/api/load_support.ts"],"names":[],"mappings":";;;AAAA,iDAAgD;AAEhD,mCAAsC;AACtC,uCAAiD;AACjD,+CAAgD;AAGhD;;;;;;GAMG;AACI,KAAK,UAAU,WAAW,CAC/B,OAA4B,EAC5B,cAA+B,EAAE;IAEjC,MAAM,EAAE,GAAG,EAAE,GAAG,IAAA,8BAAgB,EAAC,WAAW,CAAC,CAAA;IAC7C,MAAM,KAAK,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAA;IAChC,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM,IAAA,oBAAY,EACtD,GAAG,EACH,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,OAAO,CAChB,CAAA;IACD,OAAO,MAAM,IAAA,+BAAqB,EAAC;QACjC,GAAG;QACH,KAAK;QACL,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,cAAc;QAC9C,YAAY;QACZ,WAAW;KACZ,CAAC,CAAA;AACJ,CAAC;AAlBD,kCAkBC","sourcesContent":["import { IdGenerator } from '@cucumber/messages'\nimport { ILoadSupportOptions, IRunEnvironment } from './types'\nimport { resolvePaths } from './paths'\nimport { getSupportCodeLibrary } from './support'\nimport { mergeEnvironment } from './environment'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\n\n/**\n * Load support code for use in test runs.\n *\n * @public\n * @param options - Subset of `IRunnableConfiguration` required to find the support code.\n * @param environment - Project environment.\n */\nexport async function loadSupport(\n  options: ILoadSupportOptions,\n  environment: IRunEnvironment = {}\n): Promise<ISupportCodeLibrary> {\n  const { cwd } = mergeEnvironment(environment)\n  const newId = IdGenerator.uuid()\n  const { requirePaths, importPaths } = await resolvePaths(\n    cwd,\n    options.sources,\n    options.support\n  )\n  return await getSupportCodeLibrary({\n    cwd,\n    newId,\n    requireModules: options.support.requireModules,\n    requirePaths,\n    importPaths,\n  })\n}\n"]}

package/lib/api/paths.d.ts

@@ -0,0 +1,7 @@
+import { ISourcesCoordinates, ISupportCodeCoordinates } from './types';
+export declare function resolvePaths(cwd: string, sources: Pick<ISourcesCoordinates, 'paths'>, support?: ISupportCodeCoordinates): Promise<{
+    unexpandedFeaturePaths: string[];
+    featurePaths: string[];
+    requirePaths: string[];
+    importPaths: string[];
+}>;

package/lib/api/paths.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePaths = void 0;
+const util_1 = require("util");
+const glob_1 = __importDefault(require("glob"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("mz/fs"));
+async function resolvePaths(cwd, sources, support = {
+    requireModules: [],
+    requirePaths: [],
+    importPaths: [],
+}) {
+    const unexpandedFeaturePaths = await getUnexpandedFeaturePaths(cwd, sources.paths);
+    const featurePaths = await expandFeaturePaths(cwd, unexpandedFeaturePaths);
+    const { requirePaths, importPaths } = await deriveSupportPaths(cwd, featurePaths, support.requirePaths, support.importPaths);
+    return {
+        unexpandedFeaturePaths,
+        featurePaths,
+        requirePaths,
+        importPaths,
+    };
+}
+exports.resolvePaths = resolvePaths;
+async function expandPaths(cwd, unexpandedPaths, defaultExtension) {
+    const expandedPaths = await Promise.all(unexpandedPaths.map(async (unexpandedPath) => {
+        const matches = await (0, util_1.promisify)(glob_1.default)(unexpandedPath, {
+            absolute: true,
+            cwd,
+        });
+        const expanded = await Promise.all(matches.map(async (match) => {
+            if (path_1.default.extname(match) === '') {
+                return await (0, util_1.promisify)(glob_1.default)(`${match}/**/*${defaultExtension}`);
+            }
+            return [match];
+        }));
+        return expanded.flat();
+    }));
+    return expandedPaths.flat().map((x) => path_1.default.normalize(x));
+}
+async function getUnexpandedFeaturePaths(cwd, args) {
+    if (args.length > 0) {
+        const nestedFeaturePaths = await Promise.all(args.map(async (arg) => {
+            const filename = path_1.default.basename(arg);
+            if (filename[0] === '@') {
+                const filePath = path_1.default.join(cwd, arg);
+                const content = await fs_1.default.readFile(filePath, 'utf8');
+                return content.split('\n').map((x) => x.trim());
+            }
+            return [arg];
+        }));
+        const featurePaths = nestedFeaturePaths.flat();
+        if (featurePaths.length > 0) {
+            return featurePaths.filter((x) => x !== '');
+        }
+    }
+    return ['features/**/*.{feature,feature.md}'];
+}
+function getFeatureDirectoryPaths(cwd, featurePaths) {
+    const featureDirs = featurePaths.map((featurePath) => {
+        let featureDir = path_1.default.dirname(featurePath);
+        let childDir;
+        let parentDir = featureDir;
+        while (childDir !== parentDir) {
+            childDir = parentDir;
+            parentDir = path_1.default.dirname(childDir);
+            if (path_1.default.basename(parentDir) === 'features') {
+                featureDir = parentDir;
+                break;
+            }
+        }
+        return path_1.default.relative(cwd, featureDir);
+    });
+    return [...new Set(featureDirs)];
+}
+async function expandFeaturePaths(cwd, featurePaths) {
+    featurePaths = featurePaths.map((p) => p.replace(/(:\d+)*$/g, '')); // Strip line numbers
+    featurePaths = [...new Set(featurePaths)]; // Deduplicate the feature files
+    return await expandPaths(cwd, featurePaths, '.feature');
+}
+async function deriveSupportPaths(cwd, featurePaths, unexpandedRequirePaths, unexpandedImportPaths) {
+    if (unexpandedRequirePaths.length === 0 &&
+        unexpandedImportPaths.length === 0) {
+        const defaultPaths = getFeatureDirectoryPaths(cwd, featurePaths);
+        const requirePaths = await expandPaths(cwd, defaultPaths, '.js');
+        const importPaths = await expandPaths(cwd, defaultPaths, '.mjs');
+        return { requirePaths, importPaths };
+    }
+    const requirePaths = unexpandedRequirePaths.length > 0
+        ? await expandPaths(cwd, unexpandedRequirePaths, '.js')
+        : [];
+    const importPaths = unexpandedImportPaths.length > 0
+        ? await expandPaths(cwd, unexpandedImportPaths, '.@(js|cjs|mjs)')
+        : [];
+    return { requirePaths, importPaths };
+}
+//# sourceMappingURL=paths.js.map

package/lib/api/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/api/paths.ts"],"names":[],"mappings":";;;;;;AAAA,+BAAgC;AAChC,gDAAuB;AACvB,gDAAuB;AACvB,+CAAsB;AAGf,KAAK,UAAU,YAAY,CAChC,GAAW,EACX,OAA2C,EAC3C,UAAmC;IACjC,cAAc,EAAE,EAAE;IAClB,YAAY,EAAE,EAAE;IAChB,WAAW,EAAE,EAAE;CAChB;IAOD,MAAM,sBAAsB,GAAG,MAAM,yBAAyB,CAC5D,GAAG,EACH,OAAO,CAAC,KAAK,CACd,CAAA;IACD,MAAM,YAAY,GAAa,MAAM,kBAAkB,CACrD,GAAG,EACH,sBAAsB,CACvB,CAAA;IACD,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM,kBAAkB,CAC5D,GAAG,EACH,YAAY,EACZ,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,WAAW,CACpB,CAAA;IACD,OAAO;QACL,sBAAsB;QACtB,YAAY;QACZ,YAAY;QACZ,WAAW;KACZ,CAAA;AACH,CAAC;AAlCD,oCAkCC;AAED,KAAK,UAAU,WAAW,CACxB,GAAW,EACX,eAAyB,EACzB,gBAAwB;IAExB,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,GAAG,CACrC,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE;QAC3C,MAAM,OAAO,GAAG,MAAM,IAAA,gBAAS,EAAC,cAAI,CAAC,CAAC,cAAc,EAAE;YACpD,QAAQ,EAAE,IAAI;YACd,GAAG;SACJ,CAAC,CAAA;QACF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,cAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE;gBAC9B,OAAO,MAAM,IAAA,gBAAS,EAAC,cAAI,CAAC,CAAC,GAAG,KAAK,QAAQ,gBAAgB,EAAE,CAAC,CAAA;aACjE;YACD,OAAO,CAAC,KAAK,CAAC,CAAA;QAChB,CAAC,CAAC,CACH,CAAA;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC,CAAC,CACH,CAAA;IACD,OAAO,aAAa,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;AAC3D,CAAC;AAED,KAAK,UAAU,yBAAyB,CACtC,GAAW,EACX,IAAc;IAEd,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACnB,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACrB,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBACvB,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;gBACpC,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;gBACnD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;aAChD;YACD,OAAO,CAAC,GAAG,CAAC,CAAA;QACd,CAAC,CAAC,CACH,CAAA;QACD,MAAM,YAAY,GAAG,kBAAkB,CAAC,IAAI,EAAE,CAAA;QAC9C,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YAC3B,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;SAC5C;KACF;IACD,OAAO,CAAC,oCAAoC,CAAC,CAAA;AAC/C,CAAC;AAED,SAAS,wBAAwB,CAC/B,GAAW,EACX,YAAsB;IAEtB,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;QACnD,IAAI,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QAC1C,IAAI,QAAgB,CAAA;QACpB,IAAI,SAAS,GAAG,UAAU,CAAA;QAC1B,OAAO,QAAQ,KAAK,SAAS,EAAE;YAC7B,QAAQ,GAAG,SAAS,CAAA;YACpB,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAClC,IAAI,cAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,UAAU,EAAE;gBAC3C,UAAU,GAAG,SAAS,CAAA;gBACtB,MAAK;aACN;SACF;QACD,OAAO,cAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;IACF,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAA;AAClC,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,GAAW,EACX,YAAsB;IAEtB,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAA,CAAC,qBAAqB;IACxF,YAAY,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAA,CAAC,gCAAgC;IAC1E,OAAO,MAAM,WAAW,CAAC,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,CAAA;AACzD,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,GAAW,EACX,YAAsB,EACtB,sBAAgC,EAChC,qBAA+B;IAK/B,IACE,sBAAsB,CAAC,MAAM,KAAK,CAAC;QACnC,qBAAqB,CAAC,MAAM,KAAK,CAAC,EAClC;QACA,MAAM,YAAY,GAAG,wBAAwB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;QAChE,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,YAAY,EAAE,KAAK,CAAC,CAAA;QAChE,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,CAAC,CAAA;QAChE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,CAAA;KACrC;IACD,MAAM,YAAY,GAChB,sBAAsB,CAAC,MAAM,GAAG,CAAC;QAC/B,CAAC,CAAC,MAAM,WAAW,CAAC,GAAG,EAAE,sBAAsB,EAAE,KAAK,CAAC;QACvD,CAAC,CAAC,EAAE,CAAA;IACR,MAAM,WAAW,GACf,qBAAqB,CAAC,MAAM,GAAG,CAAC;QAC9B,CAAC,CAAC,MAAM,WAAW,CAAC,GAAG,EAAE,qBAAqB,EAAE,gBAAgB,CAAC;QACjE,CAAC,CAAC,EAAE,CAAA;IACR,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,CAAA;AACtC,CAAC","sourcesContent":["import { promisify } from 'util'\nimport glob from 'glob'\nimport path from 'path'\nimport fs from 'mz/fs'\nimport { ISourcesCoordinates, ISupportCodeCoordinates } from './types'\n\nexport async function resolvePaths(\n  cwd: string,\n  sources: Pick<ISourcesCoordinates, 'paths'>,\n  support: ISupportCodeCoordinates = {\n    requireModules: [],\n    requirePaths: [],\n    importPaths: [],\n  }\n): Promise<{\n  unexpandedFeaturePaths: string[]\n  featurePaths: string[]\n  requirePaths: string[]\n  importPaths: string[]\n}> {\n  const unexpandedFeaturePaths = await getUnexpandedFeaturePaths(\n    cwd,\n    sources.paths\n  )\n  const featurePaths: string[] = await expandFeaturePaths(\n    cwd,\n    unexpandedFeaturePaths\n  )\n  const { requirePaths, importPaths } = await deriveSupportPaths(\n    cwd,\n    featurePaths,\n    support.requirePaths,\n    support.importPaths\n  )\n  return {\n    unexpandedFeaturePaths,\n    featurePaths,\n    requirePaths,\n    importPaths,\n  }\n}\n\nasync function expandPaths(\n  cwd: string,\n  unexpandedPaths: string[],\n  defaultExtension: string\n): Promise<string[]> {\n  const expandedPaths = await Promise.all(\n    unexpandedPaths.map(async (unexpandedPath) => {\n      const matches = await promisify(glob)(unexpandedPath, {\n        absolute: true,\n        cwd,\n      })\n      const expanded = await Promise.all(\n        matches.map(async (match) => {\n          if (path.extname(match) === '') {\n            return await promisify(glob)(`${match}/**/*${defaultExtension}`)\n          }\n          return [match]\n        })\n      )\n      return expanded.flat()\n    })\n  )\n  return expandedPaths.flat().map((x) => path.normalize(x))\n}\n\nasync function getUnexpandedFeaturePaths(\n  cwd: string,\n  args: string[]\n): Promise<string[]> {\n  if (args.length > 0) {\n    const nestedFeaturePaths = await Promise.all(\n      args.map(async (arg) => {\n        const filename = path.basename(arg)\n        if (filename[0] === '@') {\n          const filePath = path.join(cwd, arg)\n          const content = await fs.readFile(filePath, 'utf8')\n          return content.split('\\n').map((x) => x.trim())\n        }\n        return [arg]\n      })\n    )\n    const featurePaths = nestedFeaturePaths.flat()\n    if (featurePaths.length > 0) {\n      return featurePaths.filter((x) => x !== '')\n    }\n  }\n  return ['features/**/*.{feature,feature.md}']\n}\n\nfunction getFeatureDirectoryPaths(\n  cwd: string,\n  featurePaths: string[]\n): string[] {\n  const featureDirs = featurePaths.map((featurePath) => {\n    let featureDir = path.dirname(featurePath)\n    let childDir: string\n    let parentDir = featureDir\n    while (childDir !== parentDir) {\n      childDir = parentDir\n      parentDir = path.dirname(childDir)\n      if (path.basename(parentDir) === 'features') {\n        featureDir = parentDir\n        break\n      }\n    }\n    return path.relative(cwd, featureDir)\n  })\n  return [...new Set(featureDirs)]\n}\n\nasync function expandFeaturePaths(\n  cwd: string,\n  featurePaths: string[]\n): Promise<string[]> {\n  featurePaths = featurePaths.map((p) => p.replace(/(:\\d+)*$/g, '')) // Strip line numbers\n  featurePaths = [...new Set(featurePaths)] // Deduplicate the feature files\n  return await expandPaths(cwd, featurePaths, '.feature')\n}\n\nasync function deriveSupportPaths(\n  cwd: string,\n  featurePaths: string[],\n  unexpandedRequirePaths: string[],\n  unexpandedImportPaths: string[]\n): Promise<{\n  requirePaths: string[]\n  importPaths: string[]\n}> {\n  if (\n    unexpandedRequirePaths.length === 0 &&\n    unexpandedImportPaths.length === 0\n  ) {\n    const defaultPaths = getFeatureDirectoryPaths(cwd, featurePaths)\n    const requirePaths = await expandPaths(cwd, defaultPaths, '.js')\n    const importPaths = await expandPaths(cwd, defaultPaths, '.mjs')\n    return { requirePaths, importPaths }\n  }\n  const requirePaths =\n    unexpandedRequirePaths.length > 0\n      ? await expandPaths(cwd, unexpandedRequirePaths, '.js')\n      : []\n  const importPaths =\n    unexpandedImportPaths.length > 0\n      ? await expandPaths(cwd, unexpandedImportPaths, '.@(js|cjs|mjs)')\n      : []\n  return { requirePaths, importPaths }\n}\n"]}

package/lib/api/run_cucumber.d.ts

@@ -0,0 +1,11 @@
+import { Envelope } from '@cucumber/messages';
+import { IRunOptions, IRunEnvironment, IRunResult } from './types';
+/**
+ * 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.
+ */
+export declare function runCucumber(configuration: IRunOptions, environment?: IRunEnvironment, onMessage?: (message: Envelope) => void): Promise<IRunResult>;

package/lib/api/run_cucumber.js

@@ -0,0 +1,108 @@
+"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("../formatter/helpers");
+const helpers_2 = require("../cli/helpers");
+const paths_1 = require("./paths");
+const runtime_1 = require("./runtime");
+const formatters_1 = require("./formatters");
+const support_1 = require("./support");
+const console_1 = require("console");
+const environment_1 = require("./environment");
+const gherkin_1 = require("./gherkin");
+/**
+ * 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 } = (0, environment_1.mergeEnvironment)(environment);
+    const logger = new console_1.Console(stdout, stderr);
+    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)(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 eventBroadcaster = new events_1.EventEmitter();
+    if (onMessage) {
+        eventBroadcaster.on('envelope', onMessage);
+    }
+    const eventDataCollector = new helpers_1.EventDataCollector(eventBroadcaster);
+    let formatterStreamError = false;
+    const cleanup = await (0, formatters_1.initializeFormatters)({
+        cwd,
+        stdout,
+        logger,
+        onStreamError: () => (formatterStreamError = true),
+        eventBroadcaster,
+        eventDataCollector,
+        configuration: configuration.formats,
+        supportCodeLibrary,
+    });
+    await (0, helpers_2.emitMetaMessage)(eventBroadcaster, env);
+    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 cleanup();
+        return {
+            success: false,
+            support: supportCodeLibrary,
+        };
+    }
+    (0, helpers_2.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 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,kDAAyD;AACzD,4CAAyE;AAEzE,mCAAsC;AACtC,uCAAuC;AACvC,6CAAmD;AACnD,uCAAiD;AACjD,qCAAiC;AACjC,+CAAgD;AAChD,uCAAuD;AAEvD;;;;;;;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,GAAG,IAAA,8BAAgB,EAAC,WAAW,CAAC,CAAA;IAClE,MAAM,MAAM,GAAG,IAAI,iBAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC1C,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,GAAG,EAAE,aAAa,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IAEpE,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,gBAAgB,GAAG,IAAI,qBAAY,EAAE,CAAA;IAC3C,IAAI,SAAS,EAAE;QACb,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;KAC3C;IACD,MAAM,kBAAkB,GAAG,IAAI,4BAAkB,CAAC,gBAAgB,CAAC,CAAA;IAEnE,IAAI,oBAAoB,GAAG,KAAK,CAAA;IAChC,MAAM,OAAO,GAAG,MAAM,IAAA,iCAAoB,EAAC;QACzC,GAAG;QACH,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,CAAC,CAAA;IAE5C,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,OAAO,EAAE,CAAA;QACf,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,OAAO,EAAE,CAAA;IAEf,OAAO;QACL,OAAO,EAAE,OAAO,IAAI,CAAC,oBAAoB;QACzC,OAAO,EAAE,kBAAkB;KAC5B,CAAA;AACH,CAAC;AArGD,kCAqGC","sourcesContent":["import { Envelope, IdGenerator, ParseError } from '@cucumber/messages'\nimport { EventEmitter } from 'events'\nimport { EventDataCollector } from '../formatter/helpers'\nimport { emitMetaMessage, emitSupportCodeMessages } from '../cli/helpers'\nimport { IRunOptions, IRunEnvironment, IRunResult } from './types'\nimport { resolvePaths } from './paths'\nimport { makeRuntime } from './runtime'\nimport { initializeFormatters } from './formatters'\nimport { getSupportCodeLibrary } from './support'\nimport { Console } from 'console'\nimport { mergeEnvironment } from './environment'\nimport { getFilteredPicklesAndErrors } from './gherkin'\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 } = mergeEnvironment(environment)\n  const logger = new Console(stdout, stderr)\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(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 eventBroadcaster = new EventEmitter()\n  if (onMessage) {\n    eventBroadcaster.on('envelope', onMessage)\n  }\n  const eventDataCollector = new EventDataCollector(eventBroadcaster)\n\n  let formatterStreamError = false\n  const cleanup = await initializeFormatters({\n    cwd,\n    stdout,\n    logger,\n    onStreamError: () => (formatterStreamError = true),\n    eventBroadcaster,\n    eventDataCollector,\n    configuration: configuration.formats,\n    supportCodeLibrary,\n  })\n  await emitMetaMessage(eventBroadcaster, env)\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 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 cleanup()\n\n  return {\n    success: success && !formatterStreamError,\n    support: supportCodeLibrary,\n  }\n}\n"]}

package/lib/api/runtime.d.ts

@@ -0,0 +1,20 @@
+/// <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';
+export declare function makeRuntime({ cwd, logger, eventBroadcaster, eventDataCollector, pickleIds, newId, supportCodeLibrary, requireModules, requirePaths, importPaths, options: { parallel, ...options }, }: {
+    cwd: string;
+    logger: Console;
+    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;AAGzD,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'\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: Console\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,21 @@
+"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");
+// 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.map((module) => require(module));
+    requirePaths.map((path) => require(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;AAEnC,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,CAAC,CAAA;IAC3C,cAAc,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;IAC/C,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IACzC,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE;QAC9B,MAAM,QAAQ,CAAC,IAAA,mBAAa,EAAC,IAAI,CAAC,CAAC,CAAA;KACpC;IACD,OAAO,sCAAyB,CAAC,QAAQ,EAAE,CAAA;AAC7C,CAAC;AApBD,sDAoBC","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'\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.map((module) => require(module))\n  requirePaths.map((path) => require(path))\n  for (const path of importPaths) {\n    await importer(pathToFileURL(path))\n  }\n  return supportCodeLibraryBuilder.finalize()\n}\n"]}

package/lib/api/types.d.ts

@@ -0,0 +1,168 @@
+/// <reference types="node" />
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+import { FormatOptions, IFormatterStream } from '../formatter';
+import { PickleOrder } from '../models/pickle_order';
+import { IRuntimeOptions } from '../runtime';
+import { IConfiguration } from '../configuration';
+/**
+ * @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: {
+        url?: string;
+        token?: string;
+    } | false;
+    options: FormatOptions;
+}
+/**
+ * @public
+ */
+export interface IRunConfiguration {
+    sources: ISourcesCoordinates;
+    support: ISupportCodeCoordinates;
+    runtime: IRunOptionsRuntime;
+    formats: IRunOptionsFormats;
+}
+/**
+ * @public
+ */
+export declare type ISupportCodeCoordinatesOrLibrary = ISupportCodeCoordinates | ISupportCodeLibrary;
+/**
+ * @public
+ */
+export interface IRunOptions {
+    sources: ISourcesCoordinates;
+    support: ISupportCodeCoordinatesOrLibrary;
+    runtime: IRunOptionsRuntime;
+    formats: IRunOptionsFormats;
+}
+/**
+ * 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?: IFormatterStream;
+    /**
+     * Writable stream where the test run's warning/error output is written (defaults to `process.stderr` if omitted).
+     */
+    stderr?: IFormatterStream;
+    /**
+     * Environment variables (defaults to `process.env` if omitted).
+     */
+    env?: NodeJS.ProcessEnv;
+}
+/**
+ * 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