@dev-blinq/cucumber-js 1.0.0-amdocs

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) Julien Biezemans and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+<h1 align="center">
+  <img src="./docs/images/icon.png" style="width:150px;height:150px;" alt="">
+  <br>
+  Cucumber - Blinq.io
+</h1>
+<p align="center">
+  <b>Cucumber.js with Blinq.io adaptation</b>
+</p>
+
+We took the regular old [Cucumber](https://github.com/cucumber) (A tool for running automated tests) and made improvements 
+that could be helpful when working with data that should be saved or when we want to generate fake data for testing 
+purposes in our Gherkin feature file.
+
+## Install
+
+@dev-blinq/cucumber-js is [available on npm](https://www.npmjs.com/package/@dev-blinq/cucumber-js):
+
+```shell
+$ npm install @dev-blinq/cucumber-js
+```
+
+## Get Started
+
+Before, we used to write Gherkin feature files like this -
+
+```gherkin
+Feature: Github
+    Scenario Outline: Create a new repository
+        Given Create a new repository name "<repo>"
+        Examples:
+            | repo                
+            | random_repo_name
+```
+
+Now, instead of picking a random name by ourselfs, we could fake data using the [faker](https://www.npmjs.com/package/@faker-js/faker) library and get a random value -
+
+```gherkin
+Feature: Github
+    Scenario Outline: Create a new repository
+        Given Create a new repository name "<repo>"
+        Examples:
+            | repo                
+            | {{string.alpha(10)}}
+```
+
+We could also save our fake data (or any data really) as a variable for future use using the equals (=) sign -
+
+```gherkin
+Feature: Github
+    Scenario Outline: Create a new repository
+        Given Create a new repository name "<repo>"
+        Examples:
+            |  repo                 
+            | {{repo=string.alpha(10)}}
+
+    Scenario Outline: Create a second repository
+        Given Create a new repository with the same name as before "<repo>"
+        Examples:
+            |  repo                 
+            | {{repo}}
+```
+
+In that example, we saved repo as a variable with a value of some fake data and used it again as the second repo
+value, both repos will have the same fake value.
+
+## Documentation
+
+See documentation for the [Blinq.io](https://docs.blinq.io) app.

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/bin/cucumber-js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../lib/cli/run.js').default();

package/bin/cucumber.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../lib/cli/run.js').default();

package/bin/cucumber.ts

@@ -0,0 +1,2 @@
+import run from "../src/cli/run";
+run();

package/bin/download-install.js

@@ -0,0 +1,167 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-console */
+/* eslint-disable no-undef */
+const { argv } = require('node:process')
+const fs = require('fs')
+const path = require('path')
+const JSZip = require('jszip')
+const { mkdirSync, writeFileSync } = require('node:fs')
+const axios = require('axios').default
+const tunnel = require('tunnel')
+
+let token = null
+let extractPath = null
+const getSSoUrl = () => {
+  switch (process.env.NODE_ENV_BLINQ) {
+    case 'local':
+      return 'http://localhost:5000/api/auth'
+    case 'dev':
+      return 'https://dev.api.blinq.io/api/auth'
+    case 'stage':
+      return 'https://stage.api.blinq.io/api/auth'
+    default:
+      return 'https://api.blinq.io/api/auth'
+  }
+}
+
+const getProxy = () => {
+  if (!process.env.PROXY) {
+    return null
+  }
+
+  const proxy = process.env.PROXY
+  const url = new URL(proxy)
+  const proxyObject = {
+    host: url.hostname,
+    port: Number(url.port),
+  }
+
+  const { username, password } = url
+
+  if (username && password) {
+    proxyObject.proxyAuth = `${username}:${password}`
+  }
+  return tunnel.httpsOverHttp({ proxy: proxyObject })
+}
+const getWorkSpaceUrl = () => {
+  switch (process.env.NODE_ENV_BLINQ) {
+    case 'local':
+      return 'http://localhost:6000/api/workspace'
+    case 'dev':
+      return 'https://dev.api.blinq.io/api/workspace'
+    case "stage":
+      return 'https://stage.api.blinq.io/api/workspace'
+    default:
+      return 'https://api.blinq.io/api/workspace'
+  }
+}
+
+for (let i = 2; i < argv.length; i++) {
+  const arg = argv[i]
+  switch (arg) {
+    case '--token':
+      if (i + 1 < argv.length && !argv[i + 1].startsWith('--')) {
+        token = argv[++i]
+      } else {
+        console.error('Error: --token argument provided without a token.')
+        process.exit(1)
+      }
+      break
+    case '--extractDir':
+      if (i + 1 < argv.length && !argv[i + 1].startsWith('--')) {
+        extractPath = argv[++i]
+      } else {
+        console.error('Error: --extractPath argument provided without a path.')
+        process.exit(1)
+      }
+      break
+    default:
+      console.error(`Unexpected argument: ${arg}`)
+      process.exit(1)
+  }
+}
+
+if (token === null || token === undefined || token === '') {
+  console.error('Error: --token argument not provided')
+  process.exit(1)
+}
+if (extractPath === '' || extractPath === null || extractPath === undefined) {
+  console.error('Error: --extractPath argument not provided')
+  process.exit(1)
+}
+const dirExists = (path) => {
+  try {
+    return fs.statSync(path).isDirectory()
+  } catch (e) {
+    if (e.code == 'ENOENT') {
+      // no such file or directory. File really does not exist
+      console.log('Not a valid directory: ' + path)
+      return false
+    }
+
+    console.log('Exception fs.statSync (' + path + '): ' + e)
+    throw e // something else went wrong, we don't have rights, ...
+  }
+}
+const ssoUrl = getSSoUrl()
+
+const getProjectByAccessKey = async (access_key) => {
+  const accessKeyUrl = `${ssoUrl}/getProjectByAccessKey`
+  const response = await axios.post(accessKeyUrl, {
+    access_key,
+    httpAgent: getProxy(),
+    proxy: false,
+  })
+  if (response.status !== 200) {
+    console.error('Error: Invalid access key')
+    process.exit(1)
+  }
+  return response.data
+};
+
+const downloadAndInstall = async (extractPath, token) => {
+  if (!dirExists(extractPath)) {
+    fs.mkdirSync(extractPath, { recursive: true })
+  }
+  try {
+    const data = await getProjectByAccessKey(token)
+
+    const workspaceUrl = getWorkSpaceUrl() + '/pull-workspace'
+    const res = await axios.get(workspaceUrl, {
+      params: {
+        projectId: data.project._id,
+      },
+      httpAgent: getProxy(),
+      proxy: false,
+      responseType: 'arraybuffer',
+      headers: {
+        Authorization: `Bearer ${token}`,
+        'Response-Type': 'arraybuffer',
+      },
+    })
+
+    if (res.status !== 200) {
+      console.error('Error: Unable to fetch workspace')
+      process.exit(1)
+    }
+
+    const zip = await JSZip.loadAsync(res.data)
+    for (const filename of Object.keys(zip.files)) {
+      const fileData = zip.files[filename]
+      if (!fileData.dir) {
+        const content = await fileData.async('nodebuffer')
+        const filePath = path.join(extractPath, filename)
+        mkdirSync(path.dirname(filePath), { recursive: true })
+        writeFileSync(filePath, content)
+      }
+    }
+
+    console.log('Extraction completed to:', extractPath)
+  } catch (error) {
+    console.error('Error:', error)
+  }
+}
+
+downloadAndInstall(extractPath, token).then(() =>
+  console.log('Download completed!')
+)

package/lib/api/console_logger.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import { Writable } from 'stream';
+import { ILogger } from '../logger';
+export declare class ConsoleLogger implements ILogger {
+    private stream;
+    private debugEnabled;
+    private console;
+    constructor(stream: Writable, debugEnabled: boolean);
+    debug(...content: any[]): void;
+    error(...content: any[]): void;
+    warn(...content: any[]): void;
+}

package/lib/api/console_logger.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsoleLogger = void 0;
+const console_1 = require("console");
+class ConsoleLogger {
+    constructor(stream, debugEnabled) {
+        this.stream = stream;
+        this.debugEnabled = debugEnabled;
+        this.console = new console_1.Console(this.stream);
+    }
+    debug(...content) {
+        if (this.debugEnabled) {
+            this.console.debug(...content);
+        }
+    }
+    error(...content) {
+        this.console.error(...content);
+    }
+    warn(...content) {
+        this.console.warn(...content);
+    }
+}
+exports.ConsoleLogger = ConsoleLogger;
+//# sourceMappingURL=console_logger.js.map

package/lib/api/console_logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"console_logger.js","sourceRoot":"","sources":["../../src/api/console_logger.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AAIjC,MAAa,aAAa;IAExB,YAAoB,MAAgB,EAAU,YAAqB;QAA/C,WAAM,GAAN,MAAM,CAAU;QAAU,iBAAY,GAAZ,YAAY,CAAS;QAD3D,YAAO,GAAY,IAAI,iBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACmB,CAAC;IAEvE,KAAK,CAAC,GAAG,OAAc;QACrB,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAA;SAC/B;IACH,CAAC;IAED,KAAK,CAAC,GAAG,OAAc;QACrB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAA;IAChC,CAAC;IAED,IAAI,CAAC,GAAG,OAAc;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;IAC/B,CAAC;CACF;AAjBD,sCAiBC","sourcesContent":["import { Console } from 'console'\nimport { Writable } from 'stream'\nimport { ILogger } from '../logger'\n\nexport class ConsoleLogger implements ILogger {\n  private console: Console = new Console(this.stream)\n  constructor(private stream: Writable, private debugEnabled: boolean) {}\n\n  debug(...content: any[]): void {\n    if (this.debugEnabled) {\n      this.console.debug(...content)\n    }\n  }\n\n  error(...content: any[]): void {\n    this.console.error(...content)\n  }\n\n  warn(...content: any[]): void {\n    this.console.warn(...content)\n  }\n}\n"]}

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,66 @@
+"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),
+        runName: flatConfiguration.runName,
+    };
+}
+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;AAIlB,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;QAC/C,OAAO,EAAE,iBAAiB,CAAC,OAAO;KACnC,CAAA;AACH,CAAC;AA9BD,oDA8BC;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 { IPublishConfig } from '../formatter'\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    runName: flatConfiguration.runName,\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): IPublishConfig | false {\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,14 @@
+"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,
+        debug: false,
+    }, 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;QAChB,KAAK,EAAE,KAAK;KACb,EACD,QAAQ,CACT,CAAA;AACH,CAAC;AAdD,4CAcC","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      debug: false,\n    },\n    provided\n  )\n}\n"]}

package/lib/api/formatters.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { IFormatterStream } from '../formatter';
+import { EventEmitter } from 'events';
+import { EventDataCollector } from '../formatter/helpers';
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+import { IRunOptionsFormats } from './types';
+import { ILogger } from '../logger';
+export declare function initializeFormatters({ env, cwd, stdout, logger, onStreamError, eventBroadcaster, eventDataCollector, configuration, supportCodeLibrary, }: {
+    env: NodeJS.ProcessEnv;
+    cwd: string;
+    stdout: IFormatterStream;
+    stderr: IFormatterStream;
+    logger: ILogger;
+    onStreamError: () => void;
+    eventBroadcaster: EventEmitter;
+    eventDataCollector: EventDataCollector;
+    configuration: IRunOptionsFormats;
+    supportCodeLibrary: ISupportCodeLibrary;
+}): Promise<() => Promise<void>>;

package/lib/api/formatters.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeFormatters = void 0;
+const util_1 = require("util");
+const builder_1 = __importDefault(require("../formatter/builder"));
+const fs_1 = __importDefault(require("mz/fs"));
+const path_1 = __importDefault(require("path"));
+const mkdirp_1 = require("mkdirp");
+async function initializeFormatters({ env, cwd, stdout, logger, onStreamError, eventBroadcaster, eventDataCollector, configuration, supportCodeLibrary, }) {
+    async function initializeFormatter(stream, target, type) {
+        stream.on('error', (error) => {
+            logger.error(error.message);
+            onStreamError();
+        });
+        const typeOptions = {
+            env,
+            cwd,
+            eventBroadcaster,
+            eventDataCollector,
+            log: stream.write.bind(stream),
+            parsedArgvOptions: configuration.options,
+            stream,
+            cleanup: stream === stdout
+                ? async () => await Promise.resolve()
+                : (0, util_1.promisify)(stream.end.bind(stream)),
+            supportCodeLibrary,
+        };
+        if (type === 'progress-bar' && !stream.isTTY) {
+            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', configuration.stdout));
+    const streamPromises = [];
+    Object.entries(configuration.files).forEach(([target, type]) => {
+        streamPromises.push((async (target, type) => {
+            const absoluteTarget = path_1.default.resolve(cwd, target);
+            try {
+                await (0, mkdirp_1.mkdirp)(path_1.default.dirname(absoluteTarget));
+            }
+            catch (error) {
+                logger.warn('Failed to ensure directory for formatter target exists');
+            }
+            const stream = fs_1.default.createWriteStream(null, {
+                fd: await fs_1.default.open(absoluteTarget, 'w'),
+            });
+            formatters.push(await initializeFormatter(stream, target, type));
+        })(target, type));
+    });
+    await Promise.all(streamPromises);
+    return async function () {
+        await Promise.all(formatters.map(async (f) => await f.finished()));
+    };
+}
+exports.initializeFormatters = initializeFormatters;
+//# sourceMappingURL=formatters.js.map

package/lib/api/formatters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatters.js","sourceRoot":"","sources":["../../src/api/formatters.ts"],"names":[],"mappings":";;;;;;AAIA,+BAAgC;AAEhC,mEAAmD;AACnD,+CAAsB;AACtB,gDAAuB;AAGvB,mCAA+B;AAExB,KAAK,UAAU,oBAAoB,CAAC,EACzC,GAAG,EACH,GAAG,EACH,MAAM,EACN,MAAM,EACN,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,kBAAkB,GAYnB;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,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,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,MAAM,cAAc,GAAoB,EAAE,CAAA;IAE1C,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;QAC7D,cAAc,CAAC,IAAI,CACjB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YACtB,MAAM,cAAc,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YAEhD,IAAI;gBACF,MAAM,IAAA,eAAM,EAAC,cAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAA;aAC3C;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAA;aACtE;YAED,MAAM,MAAM,GAAqB,YAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE;gBAC1D,EAAE,EAAE,MAAM,YAAE,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC;aACvC,CAAC,CAAA;YACF,UAAU,CAAC,IAAI,CAAC,MAAM,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;QAClE,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CACjB,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;IAEjC,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;AAtFD,oDAsFC","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 { WriteStream as TtyWriteStream } from 'tty'\nimport FormatterBuilder from '../formatter/builder'\nimport fs from 'mz/fs'\nimport path from 'path'\nimport { IRunOptionsFormats } from './types'\nimport { ILogger } from '../logger'\nimport { mkdirp } from 'mkdirp'\n\nexport async function initializeFormatters({\n  env,\n  cwd,\n  stdout,\n  logger,\n  onStreamError,\n  eventBroadcaster,\n  eventDataCollector,\n  configuration,\n  supportCodeLibrary,\n}: {\n  env: NodeJS.ProcessEnv\n  cwd: string\n  stdout: IFormatterStream\n  stderr: IFormatterStream\n  logger: ILogger\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      env,\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 (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  const streamPromises: Promise<void>[] = []\n\n  Object.entries(configuration.files).forEach(([target, type]) => {\n    streamPromises.push(\n      (async (target, type) => {\n        const absoluteTarget = path.resolve(cwd, target)\n\n        try {\n          await mkdirp(path.dirname(absoluteTarget))\n        } catch (error) {\n          logger.warn('Failed to ensure directory for formatter target exists')\n        }\n\n        const stream: IFormatterStream = fs.createWriteStream(null, {\n          fd: await fs.open(absoluteTarget, 'w'),\n        })\n        formatters.push(await initializeFormatter(stream, target, type))\n      })(target, type)\n    )\n  })\n\n  await Promise.all(streamPromises)\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 @@
+import { Envelope, GherkinDocument, IdGenerator, Location, ParseError, Pickle } from '@cucumber/messages';
+import { ISourcesCoordinates } from './types';
+import { ILogger } from '../logger';
+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: ILogger;
+    unexpandedFeaturePaths: string[];
+    featurePaths: string[];
+    coordinates: ISourcesCoordinates;
+    onEnvelope?: (envelope: Envelope) => void;
+}): Promise<{
+    filteredPickles: PickleWithDocument[];
+    parseErrors: ParseError[];
+}>;
+export {};