@cucumber/cucumber 8.0.0-rc.2 → 8.1.0

package/README.md

@@ -1,85 +1,116 @@
-# Cucumber.js
-
-[![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
-[![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
+<h1 align="center">
+  <img src="./docs/images/logo.svg" alt="">
+  <br>
+  Cucumber
+</h1>
+<p align="center">
+  <b>Automated tests in plain language, for Node.js</b>
+</p>
+
+[![#StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
+[![npm](https://img.shields.io/npm/v/@cucumber/cucumber.svg)](https://www.npmjs.com/package/@cucumber/cucumber)
+[![build](https://github.com/cucumber/cucumber-js/workflows/Build/badge.svg)](https://github.com/cucumber/cucumber-js/actions)
+[![coverage](https://coveralls.io/repos/github/cucumber/cucumber-js/badge.svg?branch=master)](https://coveralls.io/github/cucumber/cucumber-js?branch=master)
+[![backers](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
+[![sponsors](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
 [![pull requests](https://oselvar.com/api/badge?label=pull%20requests&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-js%2FpullRequests.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-js)
 [![issues](https://oselvar.com/api/badge?label=issues&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-js%2Fissues.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-js)
 
-[![GitHub Actions](https://github.com/cucumber/cucumber-js/workflows/Build/badge.svg)](https://github.com/cucumber/cucumber-js/actions)
-[![Dependencies](https://david-dm.org/cucumber/cucumber-js.svg)](https://david-dm.org/cucumber/cucumber-js)
-[![Coverage Status](https://coveralls.io/repos/github/cucumber/cucumber-js/badge.svg?branch=master)](https://coveralls.io/github/cucumber/cucumber-js?branch=master)
-
 [Cucumber](https://cucumber.io) is a tool for running automated tests written in plain language. Because they're
 written in plain language, they can be read by anyone on your team. Because they can be
 read by anyone, you can use them to help improve communication, collaboration and trust on
 your team.
 
-Cucumber.js is the JavaScript implementation of Cucumber and runs on the [maintained Node.js versions](https://github.com/nodejs/Release).
+This is the JavaScript implementation of Cucumber. It runs on [maintained versions](https://github.com/nodejs/Release) of Node.js. You can [quickly try it via CodeSandbox](https://codesandbox.io/s/cucumber-js-demo-2p3vrl?file=/features/greeting.feature), or read on to get started locally in a couple of minutes.
 
-## Try it now
+Looking to contribute? Read our [code of conduct](https://github.com/cucumber/.github/blob/main/CODE_OF_CONDUCT.md) first, then check the [contributing guide](./CONTRIBUTING.md) to get up and running.
 
-We've put a demo of Cucumber.js to [run in your browser](https://cucumber.github.io/cucumber-js/). Why don't you give it a try before anything else?
+## Install
 
-## Help & support
+Cucumber is [available on npm](https://www.npmjs.com/package/@cucumber/cucumber):
 
-* See here: https://cucumber.io/support.
+```shell
+$ npm install @cucumber/cucumber
+```
 
-## Contributing
+## Get Started
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.js.
+Let's take this example of something to test:
 
-## Code of Conduct
+```js
+class Greeter {
+  sayHello() {
+    return 'hello'
+  }
+}
+```
 
-Everyone interacting in this codebase and issue tracker is expected to follow the Cucumber [code of conduct](https://github.com/cucumber/cucumber/blob/master/CODE_OF_CONDUCT.md).
+First, write your feature in `features/greeting.feature`:
 
-## Install
+```gherkin
+Feature: Greeting
 
-Cucumber.js is available as an npm module.
+  Scenario: Say hello
+    When the greeter says hello
+    Then I should have heard "hello"
+```
 
-### 7.x.x and above
+Next, implement your steps in `features/support/steps.js`:
 
-``` shell
-$ npm install @cucumber/cucumber
-```
+```js
+const assert = require('assert')
+const { When, Then } = require('@cucumber/cucumber')
+const { Greeter } = require('../../src')
 
-If you're upgrading from 6.x.x or below, see the [migration guide](./docs/migration.md).
+When('the greeter says hello', function () {
+  this.whatIHeard = new Greeter().sayHello()
+});
+
+Then('I should have heard {string}', function (expectedResponse) {
+  assert.equal(this.whatIHeard, expectedResponse)
+});
+```
 
-### 6.x.x and below
+Finally, run Cucumber:
 
-``` shell
-$ npm install cucumber@6
+```shell
+$ npx cucumber-js
 ```
 
+And see the output:
+
+![Terminal output showing a successful test run with 1 scenario and 2 steps, all passing](./docs/images/readme-output.png)
+
+If you learn best by example, we have [a repo with several example projects](https://github.com/cucumber-examples/cucumber-js-examples), that might help you get going.
+
 ## Documentation
 
-The following documentation is for master. See below the documentation for older versions.
-
-* [CLI](/docs/cli.md)
-* [NodeJs Example](/docs/nodejs_example.md)
-* Support Files
-  * [World](/docs/support_files/world.md)
-  * [Step Definitions](/docs/support_files/step_definitions.md)
-  * [Hooks](/docs/support_files/hooks.md)
-  * [Timeouts](docs/support_files/timeouts.md)
-  * [Data Table Interface](/docs/support_files/data_table_interface.md)
-  * [Attachments](/docs/support_files/attachments.md)
-  * [API Reference](/docs/support_files/api_reference.md)
+The following documentation is for `main`, which might contain some unreleased features. See [documentation for older versions](./docs/older_versions.md) if you need it.
+
+* [CLI](./docs/cli.md)
+* [Configuration](./docs/configuration.md)
+* Support Code
+  * [API Reference](./docs/support_files/api_reference.md)
+  * [Attachments](./docs/support_files/attachments.md)
+  * [Data Tables](./docs/support_files/data_table_interface.md)
+  * [Hooks](./docs/support_files/hooks.md)
+  * [Step Definitions](./docs/support_files/step_definitions.md)
+  * [Timeouts](./docs/support_files/timeouts.md)
+  * [World](./docs/support_files/world.md)
 * Guides
-  * [Dry Run](./docs/dry_run.md)
+  * [Dry run](./docs/dry_run.md)
   * [ES Modules](./docs/esm.md)
-  * [Formatters](./docs/formatters.md)
-  * [Running in parallel](./docs/parallel.md)
-  * [Profiles](./docs/profiles.md)
+  * [Failing fast](./docs/fail_fast.md)
+  * [Filtering which scenarios run](./docs/filtering.md)
+  * [Formatters for feedback and reporting](./docs/formatters.md)
+  * [Parallel running for speed](./docs/parallel.md)
+  * [Profiles for composable configuration](./docs/profiles.md)
   * [Rerunning just failures](./docs/rerun.md)
   * [Retrying flaky scenarios](./docs/retry.md)
   * [Snippets for undefined steps](./docs/snippets.md)
-* [FAQ](/docs/faq.md)
+  * [Transpiling (from TypeScript etc)](./docs/transpiling.md)
+* [FAQ](./docs/faq.md)
 
-#### Documentation for older versions
+## Support
 
-* [`6.x`](https://github.com/cucumber/cucumber-js/tree/6.x)
-* [`5.x`](https://github.com/cucumber/cucumber-js/tree/5.x)
-* [`4.x`](https://github.com/cucumber/cucumber-js/tree/4.x)
-* [`3.x`](https://github.com/cucumber/cucumber-js/tree/3.x)
-* [`2.x`](https://github.com/cucumber/cucumber-js/tree/2.x)
-* [`1.x`](https://github.com/cucumber/cucumber-js/tree/1.x)
+Support is [available from the community](https://cucumber.io/tools/cucumber-open/support/) if you need it.

package/api/index.d.ts

@@ -0,0 +1,6 @@
+/*
+allows TypeScript to see `@cucumber/cucumber/api` where it doesn't yet support
+subpath exports, see <https://github.com/microsoft/TypeScript/issues/33079>
+ */
+
+export * from '../lib/api'

package/lib/api/convert_configuration.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { IConfiguration } from '../configuration';
+import { IRunConfiguration } from './types';
+export declare function convertConfiguration(flatConfiguration: IConfiguration, env: NodeJS.ProcessEnv): Promise<IRunConfiguration>;

package/lib/api/convert_configuration.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertConfiguration = void 0;
+const configuration_1 = require("../configuration");
+async function convertConfiguration(flatConfiguration, env) {
+    return {
+        sources: {
+            paths: flatConfiguration.paths,
+            defaultDialect: flatConfiguration.language,
+            names: flatConfiguration.name,
+            tagExpression: flatConfiguration.tags,
+            order: flatConfiguration.order,
+        },
+        support: {
+            requireModules: flatConfiguration.requireModule,
+            requirePaths: flatConfiguration.require,
+            importPaths: flatConfiguration.import,
+        },
+        runtime: {
+            dryRun: flatConfiguration.dryRun,
+            failFast: flatConfiguration.failFast,
+            filterStacktraces: !flatConfiguration.backtrace,
+            parallel: flatConfiguration.parallel,
+            retry: flatConfiguration.retry,
+            retryTagFilter: flatConfiguration.retryTagFilter,
+            strict: flatConfiguration.strict,
+            worldParameters: flatConfiguration.worldParameters,
+        },
+        formats: convertFormats(flatConfiguration, env),
+    };
+}
+exports.convertConfiguration = convertConfiguration;
+function convertFormats(flatConfiguration, env) {
+    var _a, _b;
+    const splitFormats = flatConfiguration.format.map((item) => configuration_1.OptionSplitter.split(item));
+    return {
+        stdout: (_b = (_a = [...splitFormats].reverse().find(([, target]) => !target)) === null || _a === void 0 ? void 0 : _a[0]) !== null && _b !== void 0 ? _b : 'progress',
+        files: splitFormats
+            .filter(([, target]) => !!target)
+            .reduce((mapped, [type, target]) => {
+            return {
+                ...mapped,
+                [target]: type,
+            };
+        }, {}),
+        publish: makePublishConfig(flatConfiguration, env),
+        options: flatConfiguration.formatOptions,
+    };
+}
+function makePublishConfig(flatConfiguration, env) {
+    const enabled = isPublishing(flatConfiguration, env);
+    if (!enabled) {
+        return false;
+    }
+    return {
+        url: env.CUCUMBER_PUBLISH_URL,
+        token: env.CUCUMBER_PUBLISH_TOKEN,
+    };
+}
+function isPublishing(flatConfiguration, env) {
+    return (flatConfiguration.publish ||
+        (0, configuration_1.isTruthyString)(env.CUCUMBER_PUBLISH_ENABLED) ||
+        env.CUCUMBER_PUBLISH_TOKEN !== undefined);
+}
+//# sourceMappingURL=convert_configuration.js.map

package/lib/api/convert_configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert_configuration.js","sourceRoot":"","sources":["../../src/api/convert_configuration.ts"],"names":[],"mappings":";;;AAAA,oDAIyB;AAGlB,KAAK,UAAU,oBAAoB,CACxC,iBAAiC,EACjC,GAAsB;IAEtB,OAAO;QACL,OAAO,EAAE;YACP,KAAK,EAAE,iBAAiB,CAAC,KAAK;YAC9B,cAAc,EAAE,iBAAiB,CAAC,QAAQ;YAC1C,KAAK,EAAE,iBAAiB,CAAC,IAAI;YAC7B,aAAa,EAAE,iBAAiB,CAAC,IAAI;YACrC,KAAK,EAAE,iBAAiB,CAAC,KAAK;SAC/B;QACD,OAAO,EAAE;YACP,cAAc,EAAE,iBAAiB,CAAC,aAAa;YAC/C,YAAY,EAAE,iBAAiB,CAAC,OAAO;YACvC,WAAW,EAAE,iBAAiB,CAAC,MAAM;SACtC;QACD,OAAO,EAAE;YACP,MAAM,EAAE,iBAAiB,CAAC,MAAM;YAChC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;YACpC,iBAAiB,EAAE,CAAC,iBAAiB,CAAC,SAAS;YAC/C,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;YACpC,KAAK,EAAE,iBAAiB,CAAC,KAAK;YAC9B,cAAc,EAAE,iBAAiB,CAAC,cAAc;YAChD,MAAM,EAAE,iBAAiB,CAAC,MAAM;YAChC,eAAe,EAAE,iBAAiB,CAAC,eAAe;SACnD;QACD,OAAO,EAAE,cAAc,CAAC,iBAAiB,EAAE,GAAG,CAAC;KAChD,CAAA;AACH,CAAC;AA7BD,oDA6BC;AAED,SAAS,cAAc,CACrB,iBAAiC,EACjC,GAAsB;;IAEtB,MAAM,YAAY,GAAe,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACrE,8BAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAC3B,CAAA;IACD,OAAO;QACL,MAAM,EACJ,MAAA,MAAA,CAAC,GAAG,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,0CAAG,CAAC,CAAC,mCAC9D,UAAU;QACZ,KAAK,EAAE,YAAY;aAChB,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;aAChC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;YACjC,OAAO;gBACL,GAAG,MAAM;gBACT,CAAC,MAAM,CAAC,EAAE,IAAI;aACf,CAAA;QACH,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,EAAE,GAAG,CAAC;QAClD,OAAO,EAAE,iBAAiB,CAAC,aAAa;KACzC,CAAA;AACH,CAAC;AAED,SAAS,iBAAiB,CACxB,iBAAiC,EACjC,GAAsB;IAEtB,MAAM,OAAO,GAAG,YAAY,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAA;IACpD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,KAAK,CAAA;KACb;IACD,OAAO;QACL,GAAG,EAAE,GAAG,CAAC,oBAAoB;QAC7B,KAAK,EAAE,GAAG,CAAC,sBAAsB;KAClC,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CACnB,iBAAiC,EACjC,GAAsB;IAEtB,OAAO,CACL,iBAAiB,CAAC,OAAO;QACzB,IAAA,8BAAc,EAAC,GAAG,CAAC,wBAAwB,CAAC;QAC5C,GAAG,CAAC,sBAAsB,KAAK,SAAS,CACzC,CAAA;AACH,CAAC","sourcesContent":["import {\n  IConfiguration,\n  isTruthyString,\n  OptionSplitter,\n} from '../configuration'\nimport { IRunConfiguration } from './types'\n\nexport async function convertConfiguration(\n  flatConfiguration: IConfiguration,\n  env: NodeJS.ProcessEnv\n): Promise<IRunConfiguration> {\n  return {\n    sources: {\n      paths: flatConfiguration.paths,\n      defaultDialect: flatConfiguration.language,\n      names: flatConfiguration.name,\n      tagExpression: flatConfiguration.tags,\n      order: flatConfiguration.order,\n    },\n    support: {\n      requireModules: flatConfiguration.requireModule,\n      requirePaths: flatConfiguration.require,\n      importPaths: flatConfiguration.import,\n    },\n    runtime: {\n      dryRun: flatConfiguration.dryRun,\n      failFast: flatConfiguration.failFast,\n      filterStacktraces: !flatConfiguration.backtrace,\n      parallel: flatConfiguration.parallel,\n      retry: flatConfiguration.retry,\n      retryTagFilter: flatConfiguration.retryTagFilter,\n      strict: flatConfiguration.strict,\n      worldParameters: flatConfiguration.worldParameters,\n    },\n    formats: convertFormats(flatConfiguration, env),\n  }\n}\n\nfunction convertFormats(\n  flatConfiguration: IConfiguration,\n  env: NodeJS.ProcessEnv\n) {\n  const splitFormats: string[][] = flatConfiguration.format.map((item) =>\n    OptionSplitter.split(item)\n  )\n  return {\n    stdout:\n      [...splitFormats].reverse().find(([, target]) => !target)?.[0] ??\n      'progress',\n    files: splitFormats\n      .filter(([, target]) => !!target)\n      .reduce((mapped, [type, target]) => {\n        return {\n          ...mapped,\n          [target]: type,\n        }\n      }, {}),\n    publish: makePublishConfig(flatConfiguration, env),\n    options: flatConfiguration.formatOptions,\n  }\n}\n\nfunction makePublishConfig(\n  flatConfiguration: IConfiguration,\n  env: NodeJS.ProcessEnv\n): any {\n  const enabled = isPublishing(flatConfiguration, env)\n  if (!enabled) {\n    return false\n  }\n  return {\n    url: env.CUCUMBER_PUBLISH_URL,\n    token: env.CUCUMBER_PUBLISH_TOKEN,\n  }\n}\n\nfunction isPublishing(\n  flatConfiguration: IConfiguration,\n  env: NodeJS.ProcessEnv\n): boolean {\n  return (\n    flatConfiguration.publish ||\n    isTruthyString(env.CUCUMBER_PUBLISH_ENABLED) ||\n    env.CUCUMBER_PUBLISH_TOKEN !== undefined\n  )\n}\n"]}

package/lib/api/environment.d.ts

@@ -0,0 +1,2 @@
+import { IRunEnvironment } from './types';
+export declare function mergeEnvironment(provided: IRunEnvironment): Required<IRunEnvironment>;

package/lib/api/environment.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeEnvironment = void 0;
+function mergeEnvironment(provided) {
+    return Object.assign({}, {
+        cwd: process.cwd(),
+        stdout: process.stdout,
+        stderr: process.stderr,
+        env: process.env,
+    }, provided);
+}
+exports.mergeEnvironment = mergeEnvironment;
+//# sourceMappingURL=environment.js.map

package/lib/api/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/api/environment.ts"],"names":[],"mappings":";;;AAEA,SAAgB,gBAAgB,CAC9B,QAAyB;IAEzB,OAAO,MAAM,CAAC,MAAM,CAClB,EAAE,EACF;QACE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;QAClB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,EACD,QAAQ,CACT,CAAA;AACH,CAAC;AAbD,4CAaC","sourcesContent":["import { IRunEnvironment } from './types'\n\nexport function mergeEnvironment(\n  provided: IRunEnvironment\n): Required<IRunEnvironment> {\n  return Object.assign(\n    {},\n    {\n      cwd: process.cwd(),\n      stdout: process.stdout,\n      stderr: process.stderr,\n      env: process.env,\n    },\n    provided\n  )\n}\n"]}

package/lib/{run → api}/formatters.d.ts

@@ -3,12 +3,14 @@ import { IFormatterStream } from '../formatter';
 import { EventEmitter } from 'events';
 import { EventDataCollector } from '../formatter/helpers';
 import { ISupportCodeLibrary } from '../support_code_library_builder/types';
-import { IFormatterConfiguration } from '../configuration';
-export declare function initializeFormatters({ cwd, stdout, eventBroadcaster, eventDataCollector, configuration, supportCodeLibrary, }: {
+import { IRunOptionsFormats } from './types';
+export declare function initializeFormatters({ cwd, stdout, logger, onStreamError, eventBroadcaster, eventDataCollector, configuration, supportCodeLibrary, }: {
     cwd: string;
     stdout: IFormatterStream;
+    logger: Console;
+    onStreamError: () => void;
     eventBroadcaster: EventEmitter;
     eventDataCollector: EventDataCollector;
-    configuration: IFormatterConfiguration;
+    configuration: IRunOptionsFormats;
     supportCodeLibrary: ISupportCodeLibrary;
 }): Promise<() => Promise<void>>;

package/lib/{run → api}/formatters.js

@@ -12,44 +12,40 @@ const path_1 = __importDefault(require("path"));
 const publish_1 = require("../formatter/publish");
 const http_stream_1 = __importDefault(require("../formatter/http_stream"));
 const stream_1 = require("stream");
-async function initializeFormatters({ cwd, stdout, eventBroadcaster, eventDataCollector, configuration = {}, supportCodeLibrary, }) {
-    var _a;
+async function initializeFormatters({ cwd, stdout, logger, onStreamError, eventBroadcaster, eventDataCollector, configuration, supportCodeLibrary, }) {
     async function initializeFormatter(stream, target, type) {
-        var _a, _b;
         stream.on('error', (error) => {
-            console.error(error.message);
-            process.exit(1);
+            logger.error(error.message);
+            onStreamError();
         });
         const typeOptions = {
             cwd,
             eventBroadcaster,
             eventDataCollector,
             log: stream.write.bind(stream),
-            parsedArgvOptions: (_a = configuration.options) !== null && _a !== void 0 ? _a : {},
+            parsedArgvOptions: configuration.options,
             stream,
             cleanup: stream === stdout
                 ? async () => await Promise.resolve()
                 : (0, util_1.promisify)(stream.end.bind(stream)),
             supportCodeLibrary,
         };
-        if ((0, value_checker_1.doesNotHaveValue)((_b = configuration.options) === null || _b === void 0 ? void 0 : _b.colorsEnabled)) {
+        if ((0, value_checker_1.doesNotHaveValue)(configuration.options.colorsEnabled)) {
             typeOptions.parsedArgvOptions.colorsEnabled = stream.isTTY;
         }
         if (type === 'progress-bar' && !stream.isTTY) {
-            console.warn(`Cannot use 'progress-bar' formatter for output to '${target}' as not a TTY. Switching to 'progress' formatter.`);
+            logger.warn(`Cannot use 'progress-bar' formatter for output to '${target}' as not a TTY. Switching to 'progress' formatter.`);
             type = 'progress';
         }
         return await builder_1.default.build(type, typeOptions);
     }
     const formatters = [];
-    formatters.push(await initializeFormatter(stdout, 'stdout', (_a = configuration.stdout) !== null && _a !== void 0 ? _a : 'progress'));
-    if (configuration.files) {
-        for (const [target, type] of Object.entries(configuration.files)) {
-            const stream = fs_1.default.createWriteStream(null, {
-                fd: await fs_1.default.open(path_1.default.resolve(cwd, target), 'w'),
-            });
-            formatters.push(await initializeFormatter(stream, target, type));
-        }
+    formatters.push(await initializeFormatter(stdout, 'stdout', configuration.stdout));
+    for (const [target, type] of Object.entries(configuration.files)) {
+        const stream = fs_1.default.createWriteStream(null, {
+            fd: await fs_1.default.open(path_1.default.resolve(cwd, target), 'w'),
+        });
+        formatters.push(await initializeFormatter(stream, target, type));
     }
     if (configuration.publish) {
         const { url = publish_1.DEFAULT_CUCUMBER_PUBLISH_URL, token } = configuration.publish;
@@ -61,7 +57,7 @@ async function initializeFormatters({ cwd, stdout, eventBroadcaster, eventDataCo
         const readerStream = new stream_1.Writable({
             objectMode: true,
             write: function (responseBody, encoding, writeCallback) {
-                console.error(responseBody);
+                logger.error(responseBody);
                 writeCallback();
             },
         });

package/lib/api/formatters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatters.js","sourceRoot":"","sources":["../../src/api/formatters.ts"],"names":[],"mappings":";;;;;;AAIA,+BAAgC;AAChC,oDAAmD;AAEnD,mEAAmD;AACnD,+CAAsB;AACtB,gDAAuB;AACvB,kDAAmE;AACnE,2EAAiD;AACjD,mCAAiC;AAG1B,KAAK,UAAU,oBAAoB,CAAC,EACzC,GAAG,EACH,MAAM,EACN,MAAM,EACN,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,kBAAkB,GAUnB;IACC,KAAK,UAAU,mBAAmB,CAChC,MAAwB,EACxB,MAAc,EACd,IAAY;QAEZ,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;YAClC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YAC3B,aAAa,EAAE,CAAA;QACjB,CAAC,CAAC,CAAA;QACF,MAAM,WAAW,GAAG;YAClB,GAAG;YACH,gBAAgB;YAChB,kBAAkB;YAClB,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;YAC9B,iBAAiB,EAAE,aAAa,CAAC,OAAO;YACxC,MAAM;YACN,OAAO,EACL,MAAM,KAAK,MAAM;gBACf,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE;gBACrC,CAAC,CAAC,IAAA,gBAAS,EAAM,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7C,kBAAkB;SACnB,CAAA;QACD,IAAI,IAAA,gCAAgB,EAAC,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;YACzD,WAAW,CAAC,iBAAiB,CAAC,aAAa,GACzC,MACD,CAAC,KAAK,CAAA;SACR;QACD,IAAI,IAAI,KAAK,cAAc,IAAI,CAAE,MAAyB,CAAC,KAAK,EAAE;YAChE,MAAM,CAAC,IAAI,CACT,sDAAsD,MAAM,oDAAoD,CACjH,CAAA;YACD,IAAI,GAAG,UAAU,CAAA;SAClB;QACD,OAAO,MAAM,iBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,UAAU,GAAgB,EAAE,CAAA;IAElC,UAAU,CAAC,IAAI,CACb,MAAM,mBAAmB,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,CAClE,CAAA;IAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;QAChE,MAAM,MAAM,GAAqB,YAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE;YAC1D,EAAE,EAAE,MAAM,YAAE,CAAC,IAAI,CAAC,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC;SAClD,CAAC,CAAA;QACF,UAAU,CAAC,IAAI,CAAC,MAAM,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;KACjE;IAED,IAAI,aAAa,CAAC,OAAO,EAAE;QACzB,MAAM,EAAE,GAAG,GAAG,sCAA4B,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,OAAO,CAAA;QAC3E,MAAM,OAAO,GAA8B,EAAE,CAAA;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;SAC1C;QACD,MAAM,MAAM,GAAG,IAAI,qBAAU,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;QAClD,MAAM,YAAY,GAAG,IAAI,iBAAQ,CAAC;YAChC,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,UAAU,YAAoB,EAAE,QAAQ,EAAE,aAAa;gBAC5D,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;gBAC1B,aAAa,EAAE,CAAA;YACjB,CAAC;SACF,CAAC,CAAA;QACF,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzB,UAAU,CAAC,IAAI,CAAC,MAAM,mBAAmB,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,CAAA;KACnE;IAED,OAAO,KAAK;QACV,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;IACpE,CAAC,CAAA;AACH,CAAC;AAzFD,oDAyFC","sourcesContent":["import Formatter, { IFormatterStream } from '../formatter'\nimport { EventEmitter } from 'events'\nimport { EventDataCollector } from '../formatter/helpers'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport { promisify } from 'util'\nimport { doesNotHaveValue } from '../value_checker'\nimport { WriteStream as TtyWriteStream } from 'tty'\nimport FormatterBuilder from '../formatter/builder'\nimport fs from 'mz/fs'\nimport path from 'path'\nimport { DEFAULT_CUCUMBER_PUBLISH_URL } from '../formatter/publish'\nimport HttpStream from '../formatter/http_stream'\nimport { Writable } from 'stream'\nimport { IRunOptionsFormats } from './types'\n\nexport async function initializeFormatters({\n  cwd,\n  stdout,\n  logger,\n  onStreamError,\n  eventBroadcaster,\n  eventDataCollector,\n  configuration,\n  supportCodeLibrary,\n}: {\n  cwd: string\n  stdout: IFormatterStream\n  logger: Console\n  onStreamError: () => void\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  configuration: IRunOptionsFormats\n  supportCodeLibrary: ISupportCodeLibrary\n}): Promise<() => Promise<void>> {\n  async function initializeFormatter(\n    stream: IFormatterStream,\n    target: string,\n    type: string\n  ): Promise<Formatter> {\n    stream.on('error', (error: Error) => {\n      logger.error(error.message)\n      onStreamError()\n    })\n    const typeOptions = {\n      cwd,\n      eventBroadcaster,\n      eventDataCollector,\n      log: stream.write.bind(stream),\n      parsedArgvOptions: configuration.options,\n      stream,\n      cleanup:\n        stream === stdout\n          ? async () => await Promise.resolve()\n          : promisify<any>(stream.end.bind(stream)),\n      supportCodeLibrary,\n    }\n    if (doesNotHaveValue(configuration.options.colorsEnabled)) {\n      typeOptions.parsedArgvOptions.colorsEnabled = (\n        stream as TtyWriteStream\n      ).isTTY\n    }\n    if (type === 'progress-bar' && !(stream as TtyWriteStream).isTTY) {\n      logger.warn(\n        `Cannot use 'progress-bar' formatter for output to '${target}' as not a TTY. Switching to 'progress' formatter.`\n      )\n      type = 'progress'\n    }\n    return await FormatterBuilder.build(type, typeOptions)\n  }\n\n  const formatters: Formatter[] = []\n\n  formatters.push(\n    await initializeFormatter(stdout, 'stdout', configuration.stdout)\n  )\n\n  for (const [target, type] of Object.entries(configuration.files)) {\n    const stream: IFormatterStream = fs.createWriteStream(null, {\n      fd: await fs.open(path.resolve(cwd, target), 'w'),\n    })\n    formatters.push(await initializeFormatter(stream, target, type))\n  }\n\n  if (configuration.publish) {\n    const { url = DEFAULT_CUCUMBER_PUBLISH_URL, token } = configuration.publish\n    const headers: { [key: string]: string } = {}\n    if (token !== undefined) {\n      headers.Authorization = `Bearer ${token}`\n    }\n    const stream = new HttpStream(url, 'GET', headers)\n    const readerStream = new Writable({\n      objectMode: true,\n      write: function (responseBody: string, encoding, writeCallback) {\n        logger.error(responseBody)\n        writeCallback()\n      },\n    })\n    stream.pipe(readerStream)\n    formatters.push(await initializeFormatter(stream, url, 'message'))\n  }\n\n  return async function () {\n    await Promise.all(formatters.map(async (f) => await f.finished()))\n  }\n}\n"]}

package/lib/api/gherkin.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import { Envelope, GherkinDocument, IdGenerator, Location, ParseError, Pickle } from '@cucumber/messages';
+import { ISourcesCoordinates } from './types';
+interface PickleWithDocument {
+    gherkinDocument: GherkinDocument;
+    location: Location;
+    pickle: Pickle;
+}
+export declare function getFilteredPicklesAndErrors({ newId, cwd, logger, unexpandedFeaturePaths, featurePaths, coordinates, onEnvelope, }: {
+    newId: IdGenerator.NewId;
+    cwd: string;
+    logger: Console;
+    unexpandedFeaturePaths: string[];
+    featurePaths: string[];
+    coordinates: ISourcesCoordinates;
+    onEnvelope?: (envelope: Envelope) => void;
+}): Promise<{
+    filteredPickles: PickleWithDocument[];
+    parseErrors: ParseError[];
+}>;
+export {};

package/lib/api/gherkin.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFilteredPicklesAndErrors = void 0;
+const gherkin_streams_1 = require("@cucumber/gherkin-streams");
+const gherkin_utils_1 = require("@cucumber/gherkin-utils");
+const pickle_filter_1 = __importDefault(require("../pickle_filter"));
+const helpers_1 = require("../cli/helpers");
+async function getFilteredPicklesAndErrors({ newId, cwd, logger, unexpandedFeaturePaths, featurePaths, coordinates, onEnvelope, }) {
+    const gherkinQuery = new gherkin_utils_1.Query();
+    const parseErrors = [];
+    await gherkinFromPaths(featurePaths, {
+        newId,
+        relativeTo: cwd,
+        defaultDialect: coordinates.defaultDialect,
+    }, (envelope) => {
+        gherkinQuery.update(envelope);
+        if (envelope.parseError) {
+            parseErrors.push(envelope.parseError);
+        }
+        onEnvelope === null || onEnvelope === void 0 ? void 0 : onEnvelope(envelope);
+    });
+    const pickleFilter = new pickle_filter_1.default({
+        cwd,
+        featurePaths: unexpandedFeaturePaths,
+        names: coordinates.names,
+        tagExpression: coordinates.tagExpression,
+    });
+    const filteredPickles = gherkinQuery
+        .getPickles()
+        .filter((pickle) => {
+        const gherkinDocument = gherkinQuery
+            .getGherkinDocuments()
+            .find((doc) => doc.uri === pickle.uri);
+        return pickleFilter.matches({ gherkinDocument, pickle });
+    })
+        .map((pickle) => {
+        const gherkinDocument = gherkinQuery
+            .getGherkinDocuments()
+            .find((doc) => doc.uri === pickle.uri);
+        const location = gherkinQuery.getLocation(pickle.astNodeIds[pickle.astNodeIds.length - 1]);
+        return {
+            gherkinDocument,
+            location,
+            pickle,
+        };
+    });
+    (0, helpers_1.orderPickles)(filteredPickles, coordinates.order, logger);
+    return {
+        filteredPickles,
+        parseErrors,
+    };
+}
+exports.getFilteredPicklesAndErrors = getFilteredPicklesAndErrors;
+async function gherkinFromPaths(paths, options, onEnvelope) {
+    return new Promise((resolve, reject) => {
+        const gherkinMessageStream = gherkin_streams_1.GherkinStreams.fromPaths(paths, options);
+        gherkinMessageStream.on('data', onEnvelope);
+        gherkinMessageStream.on('end', resolve);
+        gherkinMessageStream.on('error', reject);
+    });
+}
+//# sourceMappingURL=gherkin.js.map

package/lib/api/gherkin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gherkin.js","sourceRoot":"","sources":["../../src/api/gherkin.ts"],"names":[],"mappings":";;;;;;AAAA,+DAGkC;AASlC,2DAA+D;AAC/D,qEAA2C;AAC3C,4CAA6C;AAStC,KAAK,UAAU,2BAA2B,CAAC,EAChD,KAAK,EACL,GAAG,EACH,MAAM,EACN,sBAAsB,EACtB,YAAY,EACZ,WAAW,EACX,UAAU,GASX;IAIC,MAAM,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAA;IACvC,MAAM,WAAW,GAAiB,EAAE,CAAA;IACpC,MAAM,gBAAgB,CACpB,YAAY,EACZ;QACE,KAAK;QACL,UAAU,EAAE,GAAG;QACf,cAAc,EAAE,WAAW,CAAC,cAAc;KAC3C,EACD,CAAC,QAAQ,EAAE,EAAE;QACX,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC7B,IAAI,QAAQ,CAAC,UAAU,EAAE;YACvB,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;SACtC;QACD,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAG,QAAQ,CAAC,CAAA;IACxB,CAAC,CACF,CAAA;IACD,MAAM,YAAY,GAAG,IAAI,uBAAY,CAAC;QACpC,GAAG;QACH,YAAY,EAAE,sBAAsB;QACpC,KAAK,EAAE,WAAW,CAAC,KAAK;QACxB,aAAa,EAAE,WAAW,CAAC,aAAa;KACzC,CAAC,CAAA;IACF,MAAM,eAAe,GAAyB,YAAY;SACvD,UAAU,EAAE;SACZ,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;QACjB,MAAM,eAAe,GAAG,YAAY;aACjC,mBAAmB,EAAE;aACrB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,CAAC,CAAA;QACxC,OAAO,YAAY,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAA;IAC1D,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACd,MAAM,eAAe,GAAG,YAAY;aACjC,mBAAmB,EAAE;aACrB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,CAAC,CAAA;QACxC,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,CACvC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAChD,CAAA;QACD,OAAO;YACL,eAAe;YACf,QAAQ;YACR,MAAM;SACP,CAAA;IACH,CAAC,CAAC,CAAA;IACJ,IAAA,sBAAY,EAAC,eAAe,EAAE,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACxD,OAAO;QACL,eAAe;QACf,WAAW;KACZ,CAAA;AACH,CAAC;AArED,kEAqEC;AAED,KAAK,UAAU,gBAAgB,CAC7B,KAAe,EACf,OAA8B,EAC9B,UAAwC;IAExC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,oBAAoB,GAAG,gCAAc,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACrE,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QAC3C,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACvC,oBAAoB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {\n  GherkinStreams,\n  IGherkinStreamOptions,\n} from '@cucumber/gherkin-streams'\nimport {\n  Envelope,\n  GherkinDocument,\n  IdGenerator,\n  Location,\n  ParseError,\n  Pickle,\n} from '@cucumber/messages'\nimport { Query as GherkinQuery } from '@cucumber/gherkin-utils'\nimport PickleFilter from '../pickle_filter'\nimport { orderPickles } from '../cli/helpers'\nimport { ISourcesCoordinates } from './types'\n\ninterface PickleWithDocument {\n  gherkinDocument: GherkinDocument\n  location: Location\n  pickle: Pickle\n}\n\nexport async function getFilteredPicklesAndErrors({\n  newId,\n  cwd,\n  logger,\n  unexpandedFeaturePaths,\n  featurePaths,\n  coordinates,\n  onEnvelope,\n}: {\n  newId: IdGenerator.NewId\n  cwd: string\n  logger: Console\n  unexpandedFeaturePaths: string[]\n  featurePaths: string[]\n  coordinates: ISourcesCoordinates\n  onEnvelope?: (envelope: Envelope) => void\n}): Promise<{\n  filteredPickles: PickleWithDocument[]\n  parseErrors: ParseError[]\n}> {\n  const gherkinQuery = new GherkinQuery()\n  const parseErrors: ParseError[] = []\n  await gherkinFromPaths(\n    featurePaths,\n    {\n      newId,\n      relativeTo: cwd,\n      defaultDialect: coordinates.defaultDialect,\n    },\n    (envelope) => {\n      gherkinQuery.update(envelope)\n      if (envelope.parseError) {\n        parseErrors.push(envelope.parseError)\n      }\n      onEnvelope?.(envelope)\n    }\n  )\n  const pickleFilter = new PickleFilter({\n    cwd,\n    featurePaths: unexpandedFeaturePaths,\n    names: coordinates.names,\n    tagExpression: coordinates.tagExpression,\n  })\n  const filteredPickles: PickleWithDocument[] = gherkinQuery\n    .getPickles()\n    .filter((pickle) => {\n      const gherkinDocument = gherkinQuery\n        .getGherkinDocuments()\n        .find((doc) => doc.uri === pickle.uri)\n      return pickleFilter.matches({ gherkinDocument, pickle })\n    })\n    .map((pickle) => {\n      const gherkinDocument = gherkinQuery\n        .getGherkinDocuments()\n        .find((doc) => doc.uri === pickle.uri)\n      const location = gherkinQuery.getLocation(\n        pickle.astNodeIds[pickle.astNodeIds.length - 1]\n      )\n      return {\n        gherkinDocument,\n        location,\n        pickle,\n      }\n    })\n  orderPickles(filteredPickles, coordinates.order, logger)\n  return {\n    filteredPickles,\n    parseErrors,\n  }\n}\n\nasync function gherkinFromPaths(\n  paths: string[],\n  options: IGherkinStreamOptions,\n  onEnvelope: (envelope: Envelope) => void\n): Promise<void> {\n  return new Promise((resolve, reject) => {\n    const gherkinMessageStream = GherkinStreams.fromPaths(paths, options)\n    gherkinMessageStream.on('data', onEnvelope)\n    gherkinMessageStream.on('end', resolve)\n    gherkinMessageStream.on('error', reject)\n  })\n}\n"]}

package/lib/api/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Cucumber for JavaScript
+ *
+ * @remarks These docs cover the API used for running Cucumber programmatically. The entry point is `@cucumber/cucumber/api`.
+ * @packageDocumentation
+ */
+export * from './load_configuration';
+export * from './load_sources';
+export * from './load_support';
+export * from './run_cucumber';
+export * from './types';

package/lib/api/index.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * Cucumber for JavaScript
+ *
+ * @remarks These docs cover the API used for running Cucumber programmatically. The entry point is `@cucumber/cucumber/api`.
+ * @packageDocumentation
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./load_configuration"), exports);
+__exportStar(require("./load_sources"), exports);
+__exportStar(require("./load_support"), exports);
+__exportStar(require("./run_cucumber"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/lib/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;AAEH,uDAAoC;AACpC,iDAA8B;AAC9B,iDAA8B;AAC9B,iDAA8B;AAC9B,0CAAuB","sourcesContent":["/**\n * Cucumber for JavaScript\n *\n * @remarks These docs cover the API used for running Cucumber programmatically. The entry point is `@cucumber/cucumber/api`.\n * @packageDocumentation\n */\n\nexport * from './load_configuration'\nexport * from './load_sources'\nexport * from './load_support'\nexport * from './run_cucumber'\nexport * from './types'\n"]}

package/lib/api/load_configuration.d.ts

@@ -0,0 +1,9 @@
+import { IRunEnvironment, IResolvedConfiguration, ILoadConfigurationOptions } from './types';
+/**
+ * Load user-authored configuration to be used in a test run.
+ *
+ * @public
+ * @param options - Coordinates required to find configuration.
+ * @param environment - Project environment.
+ */
+export declare function loadConfiguration(options?: ILoadConfigurationOptions, environment?: IRunEnvironment): Promise<IResolvedConfiguration>;

package/lib/api/load_configuration.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfiguration = void 0;
+const locate_file_1 = require("../configuration/locate_file");
+const configuration_1 = require("../configuration");
+const validate_configuration_1 = require("../configuration/validate_configuration");
+const convert_configuration_1 = require("./convert_configuration");
+const environment_1 = require("./environment");
+/**
+ * Load user-authored configuration to be used in a test run.
+ *
+ * @public
+ * @param options - Coordinates required to find configuration.
+ * @param environment - Project environment.
+ */
+async function loadConfiguration(options = {}, environment = {}) {
+    var _a;
+    const { cwd, env } = (0, environment_1.mergeEnvironment)(environment);
+    const configFile = (_a = options.file) !== null && _a !== void 0 ? _a : (0, locate_file_1.locateFile)(cwd);
+    const profileConfiguration = configFile
+        ? await (0, configuration_1.fromFile)(cwd, configFile, options.profiles)
+        : {};
+    const original = (0, configuration_1.mergeConfigurations)(configuration_1.DEFAULT_CONFIGURATION, profileConfiguration, options.provided);
+    (0, validate_configuration_1.validateConfiguration)(original);
+    const runnable = await (0, convert_configuration_1.convertConfiguration)(original, env);
+    return {
+        useConfiguration: original,
+        runConfiguration: runnable,
+    };
+}
+exports.loadConfiguration = loadConfiguration;
+//# sourceMappingURL=load_configuration.js.map

package/lib/api/load_configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load_configuration.js","sourceRoot":"","sources":["../../src/api/load_configuration.ts"],"names":[],"mappings":";;;AAKA,8DAAyD;AACzD,oDAIyB;AACzB,oFAA+E;AAC/E,mEAA8D;AAC9D,+CAAgD;AAEhD;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CACrC,UAAqC,EAAE,EACvC,cAA+B,EAAE;;IAEjC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAA,8BAAgB,EAAC,WAAW,CAAC,CAAA;IAClD,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,IAAA,wBAAU,EAAC,GAAG,CAAC,CAAA;IAClD,MAAM,oBAAoB,GAAG,UAAU;QACrC,CAAC,CAAC,MAAM,IAAA,wBAAQ,EAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC;QACnD,CAAC,CAAC,EAAE,CAAA;IACN,MAAM,QAAQ,GAAG,IAAA,mCAAmB,EAClC,qCAAqB,EACrB,oBAAoB,EACpB,OAAO,CAAC,QAAQ,CACjB,CAAA;IACD,IAAA,8CAAqB,EAAC,QAAQ,CAAC,CAAA;IAC/B,MAAM,QAAQ,GAAG,MAAM,IAAA,4CAAoB,EAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAC1D,OAAO;QACL,gBAAgB,EAAE,QAAQ;QAC1B,gBAAgB,EAAE,QAAQ;KAC3B,CAAA;AACH,CAAC;AApBD,8CAoBC","sourcesContent":["import {\n  IRunEnvironment,\n  IResolvedConfiguration,\n  ILoadConfigurationOptions,\n} from './types'\nimport { locateFile } from '../configuration/locate_file'\nimport {\n  DEFAULT_CONFIGURATION,\n  fromFile,\n  mergeConfigurations,\n} from '../configuration'\nimport { validateConfiguration } from '../configuration/validate_configuration'\nimport { convertConfiguration } from './convert_configuration'\nimport { mergeEnvironment } from './environment'\n\n/**\n * Load user-authored configuration to be used in a test run.\n *\n * @public\n * @param options - Coordinates required to find configuration.\n * @param environment - Project environment.\n */\nexport async function loadConfiguration(\n  options: ILoadConfigurationOptions = {},\n  environment: IRunEnvironment = {}\n): Promise<IResolvedConfiguration> {\n  const { cwd, env } = mergeEnvironment(environment)\n  const configFile = options.file ?? locateFile(cwd)\n  const profileConfiguration = configFile\n    ? await fromFile(cwd, configFile, options.profiles)\n    : {}\n  const original = mergeConfigurations(\n    DEFAULT_CONFIGURATION,\n    profileConfiguration,\n    options.provided\n  )\n  validateConfiguration(original)\n  const runnable = await convertConfiguration(original, env)\n  return {\n    useConfiguration: original,\n    runConfiguration: runnable,\n  }\n}\n"]}

package/lib/api/load_sources.d.ts

@@ -0,0 +1,9 @@
+import { ILoadSourcesResult, IRunEnvironment, ISourcesCoordinates } from './types';
+/**
+ * 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.
+ */
+export declare function loadSources(coordinates: ISourcesCoordinates, environment?: IRunEnvironment): Promise<ILoadSourcesResult>;