@zohodesk/testinglibrary 0.1.8-exp-bdd-v2 → 0.1.8-exp-bdd-v3

package/build/bdd-poc/test/stepGenerate/stepFileGenerate.js

@@ -13,7 +13,7 @@ var _testStructure = require("../testStructure");
 async function stepFileCreation(featureContent, stepFilename, featureFilePath) {
   const generatedFolderPath = _path.default.resolve(process.cwd(), 'uat', 'feature-gen');
   if (!(0, _fs.existsSync)(generatedFolderPath)) {
-    (0, _fs.mkdirSync)('./feature-gen', {
+    (0, _fs.mkdirSync)(generatedFolderPath, {
       recursive: true
     });
   }

package/build/core/playwright/index.js

@@ -3,13 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.When = exports.Then = exports.Given = void 0;
-Object.defineProperty(exports, "createBdd", {
-  enumerable: true,
-  get: function () {
-    return _bddFramework.createBdd;
-  }
-});
 Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
@@ -17,9 +10,10 @@ Object.defineProperty(exports, "expect", {
   }
 });
 exports.test = void 0;
-var _bddFramework = require("../../bdd-framework");
 var _test = require("@playwright/test");
 var _readConfigFile = require("./readConfigFile");
+// import { createBdd, test as bddBase } from '../../bdd-framework';
+
 // function test(descrition, callback) {
 //   return test(descrition, ({ page }) => {
 //     const { locator, ...custompage } = page
@@ -54,7 +48,7 @@ const {
   additionalPages,
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
-let base = bddMode ? _bddFramework.test : _test.test;
+let base = bddMode ? bddBase : _test.test;
 const test = base.extend({
   page: async ({
     page
@@ -101,12 +95,6 @@ const test = base.extend({
   },
   ...additionalPages
 });
-exports.test = test;
-const {
-  Given,
-  When,
-  Then
-} = (0, _bddFramework.createBdd)();
-exports.Then = Then;
-exports.When = When;
-exports.Given = Given;
+
+// const { Given, When, Then } = createBdd();
+exports.test = test;

package/build/core/playwright/setup/config-utils.js

@@ -5,11 +5,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getProjects = getProjects;
-exports.getTestDir = getTestDir;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _bddFramework = require("../../../bdd-framework");
+// import { defineBddConfig } from '../../../bdd-framework';
+
 function getBrowserConfig({
   browserName,
   isAuthMode,
@@ -98,14 +98,15 @@ function getProjects({
     viewport
   })).filter(Boolean);
 }
-function getTestDir(bddMode, cwd, {
-  stepDefinitionsFolder
-}) {
-  return bddMode ? (0, _bddFramework.defineBddConfig)({
-    paths: [_path.default.join(cwd, 'uat', '**', '*.feature')],
-    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
-    featuresRoot: _path.default.join(cwd, 'uat'),
-    outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
-    publish: true
-  }) : _path.default.join(cwd, 'uat');
-}
+
+// function getTestDir(bddMode, cwd, { stepDefinitionsFolder }) {
+//   return bddMode
+//     ? defineBddConfig({
+//       paths: [path.join(cwd, 'uat', '**', '*.feature')],
+//       import: [path.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
+//       featuresRoot: path.join(cwd, 'uat'),
+//       outputDir: path.join(cwd, 'uat', '.features-gen'),
+//       publish: true,
+//     })
+//     : path.join(cwd, 'uat');
+// }

package/build/core/playwright/test-runner.js

@@ -31,32 +31,36 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
   }
   return playwrightArgs;
 }
-function runPreprocessing(tagArgs, configPath) {
-  const beforeCommand = 'node';
-  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
-  const beforeArgs = [bddGenPath, '-c', configPath];
-  if (tagArgs) {
-    beforeArgs.push('--tags');
-    beforeArgs.push(tagArgs);
-  }
-  return new Promise((resolve, reject) => {
-    const childProcessForPreprocessing = (0, _child_process.spawn)(beforeCommand, beforeArgs, {
-      stdio: 'inherit'
-    });
-    childProcessForPreprocessing.on('error', data => {
-      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, data);
-      reject();
-    });
-    childProcessForPreprocessing.on('exit', code => {
-      if (code === 0) {
-        _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature Files Processed Successfully');
-        resolve();
-      } else {
-        reject(`BddGen exited with code ${code}`);
-      }
-    });
-  });
-}
+
+// function runPreprocessing(tagArgs, configPath) {
+//   const beforeCommand = 'node';
+//   const bddGenPath = path.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
+//   const beforeArgs = [bddGenPath, '-c', configPath];
+
+//   if (tagArgs) {
+//     beforeArgs.push('--tags');
+//     beforeArgs.push(tagArgs);
+//   }
+
+//   return new Promise((resolve, reject) => {
+//     const childProcessForPreprocessing = spawn(beforeCommand, beforeArgs, { stdio: 'inherit' });
+
+//     childProcessForPreprocessing.on('error', (data) => {
+//       Logger.log(Logger.FAILURE_TYPE, data);
+//       reject();
+//     });
+
+//     childProcessForPreprocessing.on('exit', (code) => {
+//       if (code === 0) {
+//         Logger.log(Logger.SUCCESS_TYPE, 'Feature Files Processed Successfully');
+//         resolve();
+//       } else {
+//         reject(`BddGen exited with code ${code}`);
+//       }
+//     });
+//   });
+// }
+
 function runPlaywright(command, args) {
   return new Promise((resolve, reject) => {
     const childProcessForRunningPlaywright = (0, _child_process.spawn)(command, args, {

package/build/decorators.d.ts

@@ -1 +1 @@
-export * from './bdd-framework/decorators';
+// export * from './bdd-framework/decorators';

package/build/decorators.js

@@ -1,16 +1,2 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _decorators = require("./bdd-framework/decorators");
-Object.keys(_decorators).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _decorators[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _decorators[key];
-    }
-  });
-});
+// export * from './bdd-framework/decorators';
+"use strict";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.8-exp-bdd-v2",
+  "version": "0.1.8-exp-bdd-v3",
   "description": "",
   "main": "./build/index.js",
   "scripts": {

package/build/bdd-framework/cli/commands/env.js

@@ -1,43 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.envCommand = void 0;
-exports.getOwnVersion = getOwnVersion;
-var _commander = require("commander");
-var _options = require("../options");
-var _path = _interopRequireDefault(require("path"));
-var _logger = require("../../utils/logger");
-var _utils = require("../../utils");
-var _loadConfig = require("../../playwright/loadConfig");
-const logger = new _logger.Logger({
-  verbose: true
-});
-const envCommand = new _commander.Command('env').description('Prints environment info').addOption(_options.configOption).action(opts => {
-  logger.log(`Playwright-bdd environment info:\n`);
-  logger.log(`platform: ${process.platform}`);
-  logger.log(`node: ${process.version}`);
-  showPackageVersion('playwright-bdd');
-  showPackageVersion('@playwright/test');
-  showPackageVersion('@cucumber/cucumber');
-  showPlaywrightConfigPath(opts.config);
-});
-exports.envCommand = envCommand;
-function showPackageVersion(packageName) {
-  const version = packageName === 'playwright-bdd' ? getOwnVersion() : (0, _utils.getPackageVersion)(packageName);
-  logger.log(`${packageName}: v${version}`);
-}
-/**
- * Getting own version by relative path instead of using getPackageVersion(),
- * to aneble using directly from /dist in tests.
- */
-function getOwnVersion() {
-  return '5.4.0';
-}
-function showPlaywrightConfigPath(cliConfigPath) {
-  const resolvedConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);
-  const relPath = _path.default.relative(process.cwd(), resolvedConfigFile);
-  logger.log(`Playwright config file: ${relPath}`);
-}

package/build/bdd-framework/cli/commands/export.js

@@ -1,48 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.exportCommand = void 0;
-var _path = _interopRequireDefault(require("path"));
-var _commander = require("commander");
-var _options = require("../options");
-var _loadConfig = require("../../playwright/loadConfig");
-var _logger = require("../../utils/logger");
-var _env = require("../../config/env");
-var _test = require("./test");
-var _gen = require("../../gen");
-const logger = new _logger.Logger({
-  verbose: true
-});
-const exportCommand = new _commander.Command('export').description('Prints all step definitions').addOption(_options.configOption).action(async opts => {
-  const {
-    resolvedConfigFile
-  } = await (0, _loadConfig.loadConfig)(opts.config);
-  logger.log(`List of all steps found by config: ${_path.default.relative(process.cwd(), resolvedConfigFile)}\n`);
-  const configs = Object.values((0, _env.getEnvConfigs)());
-  (0, _test.assertConfigsCount)(configs);
-  await showStepsForConfigs(configs);
-});
-exports.exportCommand = exportCommand;
-async function showStepsForConfigs(configs) {
-  // here we don't need workers (as in test command) because if some step files
-  // are already in node cache, we collected them.
-  const steps = new Set();
-  const tasks = configs.map(async config => {
-    const stepDefinitions = await new _gen.TestFilesGenerator(config).extractSteps();
-    stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
-  });
-  await Promise.all(tasks);
-  steps.forEach(stepText => logger.log(stepText));
-}
-function getStepText({
-  pattern,
-  keyword
-}) {
-  // for Unknown return When as it looks the most suitable
-  const keywordText = keyword === 'Unknown' ? 'When' : keyword;
-  const patternText = typeof pattern === 'string' ? pattern : pattern.source;
-  return `${keywordText} ${patternText}`;
-}

package/build/bdd-framework/cli/commands/test.js

@@ -1,61 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.assertConfigsCount = assertConfigsCount;
-exports.testCommand = void 0;
-var _worker_threads = require("worker_threads");
-var _events = require("events");
-var _path = _interopRequireDefault(require("path"));
-var _commander = require("commander");
-var _gen = require("../../gen");
-var _loadConfig = require("../../playwright/loadConfig");
-var _env = require("../../config/env");
-var _config = require("../../config");
-var _options = require("../options");
-var _exit = require("../../utils/exit");
-const GEN_WORKER_PATH = _path.default.resolve(__dirname, '..', 'worker.js');
-const testCommand = new _commander.Command('test').description('Generate Playwright test files from Gherkin documents').addOption(_options.configOption).option('--tags <expression>', `Tags expression to filter scenarios for generation`).option('--verbose', `Verbose mode (default: ${Boolean(_config.defaults.verbose)})`).action(async opts => {
-  await (0, _loadConfig.loadConfig)(opts.config);
-  const configs = readConfigsFromEnv();
-  mergeCliOptions(configs, opts);
-  await generateFilesForConfigs(configs);
-});
-exports.testCommand = testCommand;
-function readConfigsFromEnv() {
-  const configs = Object.values((0, _env.getEnvConfigs)());
-  assertConfigsCount(configs);
-  return configs;
-}
-function mergeCliOptions(configs, opts) {
-  configs.forEach(config => {
-    if ('tags' in opts) config.tags = opts.tags;
-    if ('verbose' in opts) config.verbose = Boolean(opts.verbose);
-  });
-}
-function assertConfigsCount(configs) {
-  if (configs.length === 0) {
-    (0, _exit.exit)(`No BDD configs found. Did you use defineBddConfig() in playwright.config.ts?`);
-  }
-}
-async function generateFilesForConfigs(configs) {
-  // run first config in main thread and other in workers (to have fresh require cache)
-  // See: https://github.com/vitalets/playwright-bdd/issues/32
-  const tasks = configs.map((config, index) => {
-    return index === 0 ? new _gen.TestFilesGenerator(config).generate() : runInWorker(config);
-  });
-  return Promise.all(tasks);
-}
-async function runInWorker(config) {
-  const worker = new _worker_threads.Worker(GEN_WORKER_PATH, {
-    workerData: {
-      config
-    }
-  });
-  const [exitCode] = await (0, _events.once)(worker, 'exit');
-  if (exitCode) {
-    (0, _exit.exit)();
-  }
-}

package/build/bdd-framework/cli/index.js

@@ -1,11 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-var _commander = require("commander");
-var _test = require("./commands/test");
-var _env = require("./commands/env");
-var _export = require("./commands/export");
-const program = new _commander.Command();
-program.name('bddgen').description(`Playwright-bdd CLI v${(0, _env.getOwnVersion)()}`).addCommand(_test.testCommand, {
-  isDefault: true
-}).addCommand(_export.exportCommand).addCommand(_env.envCommand).addHelpCommand(false).parse();

package/build/bdd-framework/cli/options.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.configOption = void 0;
-exports.getCliConfigPath = getCliConfigPath;
-var _commander = require("commander");
-/**
- * Config option moved to separate file as it used in test run.
- */
-
-const configOption = new _commander.Option(`-c, --config <file>`, `Path to Playwright configuration file (default: playwright.config.(js|ts))`);
-/**
- * Helper used in test run to detect config location.
- */
-exports.configOption = configOption;
-function getCliConfigPath() {
-  return new _commander.Command().allowUnknownOption().addOption(configOption).parse().getOptionValue('config');
-}

package/build/bdd-framework/cli/worker.js

@@ -1,13 +0,0 @@
-"use strict";
-
-var _worker_threads = require("worker_threads");
-var _gen = require("../gen");
-/**
- * Worker to generate test files with fresh require/import cache
- * See: https://github.com/nodejs/modules/issues/307#issuecomment-858729422
- */
-
-async function main() {
-  await new _gen.TestFilesGenerator(_worker_threads.workerData.config).generate();
-}
-main();

package/build/bdd-framework/config/dir.js

@@ -1,27 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getPlaywrightConfigDir = getPlaywrightConfigDir;
-var _path = _interopRequireDefault(require("path"));
-var _loadConfig = require("../playwright/loadConfig");
-var _options = require("../cli/options");
-/**
- * Store playwright config dir in env to provide access to it in workers.
- * Important that in workers there is different process.argv, that's why we save it to env.
- * Config dir is needed to resolve all paths.
- */
-
-/**
- * Resolve playwright config dir considering cli flags.
- */
-function getPlaywrightConfigDir() {
-  if (!process.env.PLAYWRIGHT_BDD_CONFIG_DIR) {
-    const cliConfigPath = (0, _options.getCliConfigPath)();
-    const playwrightConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);
-    process.env.PLAYWRIGHT_BDD_CONFIG_DIR = playwrightConfigFile ? _path.default.dirname(playwrightConfigFile) : process.cwd();
-  }
-  return process.env.PLAYWRIGHT_BDD_CONFIG_DIR;
-}

package/build/bdd-framework/config/env.js

@@ -1,49 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getConfigFromEnv = getConfigFromEnv;
-exports.getEnvConfigs = getEnvConfigs;
-exports.saveConfigToEnv = saveConfigToEnv;
-var _path = _interopRequireDefault(require("path"));
-var _exit = require("../utils/exit");
-/**
- * Storing configs in env var PLAYWRIGHT_BDD_CONFIGS as JSON-stringified values.
- * For passing configs to playwright workers and bddgen.
- */
-
-function saveConfigToEnv(config) {
-  const envConfigs = getEnvConfigs();
-  const existingConfig = envConfigs[config.outputDir];
-  if (existingConfig) {
-    // Playwright config can be evaluated several times.
-    // Throw error only if different calls of defineBddConfig() use the same outputDir.
-    // See: https://github.com/vitalets/playwright-bdd/issues/39#issuecomment-1653805368
-    if (!isSameConfigs(config, existingConfig)) {
-      (0, _exit.exit)(`When using several calls of defineBddConfig()`, `please manually provide different "outputDir" option.`);
-    }
-    return;
-  }
-  envConfigs[config.outputDir] = config;
-  saveEnvConfigs(envConfigs);
-}
-function getConfigFromEnv(outputDir) {
-  const envConfigs = getEnvConfigs();
-  outputDir = _path.default.resolve(outputDir);
-  const config = envConfigs[outputDir];
-  if (!config) {
-    (0, _exit.exit)(`Config not found for outputDir: "${outputDir}".`, `Available dirs: ${Object.keys(envConfigs).join('\n')}`);
-  }
-  return config;
-}
-function getEnvConfigs() {
-  return JSON.parse(process.env.PLAYWRIGHT_BDD_CONFIGS || '{}');
-}
-function saveEnvConfigs(envConfigs) {
-  process.env.PLAYWRIGHT_BDD_CONFIGS = JSON.stringify(envConfigs);
-}
-function isSameConfigs(config1, config2) {
-  return JSON.stringify(config1) === JSON.stringify(config2);
-}

package/build/bdd-framework/config/index.js

@@ -1,91 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.defaults = void 0;
-exports.defineBddConfig = defineBddConfig;
-exports.extractCucumberConfig = extractCucumberConfig;
-var _path = _interopRequireDefault(require("path"));
-var _env = require("./env");
-var _dir = require("./dir");
-var _utils = require("../utils");
-/**
- * BDD Config.
- */
-
-const defaults = {
-  outputDir: '.features-gen',
-  verbose: false,
-  examplesTitleFormat: 'Example #<_index_>',
-  publishQuiet: true,
-  quotes: 'double'
-};
-exports.defaults = defaults;
-function defineBddConfig(inputConfig) {
-  const config = getConfig(inputConfig);
-  // In main process store config in env to be accessible by workers
-  if (!process.env.TEST_WORKER_INDEX) {
-    (0, _env.saveConfigToEnv)(config);
-  }
-  return config.outputDir;
-}
-function getConfig(inputConfig) {
-  const config = Object.assign({}, defaults, inputConfig);
-  const configDir = (0, _dir.getPlaywrightConfigDir)();
-  const featuresRoot = config.featuresRoot ? _path.default.resolve(configDir, config.featuresRoot) : configDir;
-  return {
-    ...config,
-    // important to resolve outputDir as it is used as unique key for input configs
-    outputDir: _path.default.resolve(configDir, config.outputDir),
-    importTestFrom: resolveImportTestFrom(configDir, config.importTestFrom),
-    featuresRoot
-  };
-}
-function extractCucumberConfig(config) {
-  // todo: find more strict way to omit own config fields
-  // see: https://bobbyhadz.com/blog/typescript-object-remove-property
-  const omitProps = {
-    outputDir: true,
-    importTestFrom: true,
-    verbose: true,
-    skip: true,
-    examplesTitleFormat: true,
-    quotes: true,
-    tags: true,
-    featuresRoot: true
-  };
-  const keys = Object.keys(omitProps);
-  const cucumberConfig = {
-    ...config
-  };
-  keys.forEach(key => delete cucumberConfig[key]);
-  stripPublishQuiet(cucumberConfig);
-  return cucumberConfig;
-}
-function resolveImportTestFrom(configDir, importTestFrom) {
-  if (importTestFrom) {
-    const {
-      file,
-      varName
-    } = typeof importTestFrom === 'string' ? {
-      file: importTestFrom
-    } : importTestFrom;
-    return {
-      file: _path.default.resolve(configDir, file),
-      varName
-    };
-  }
-}
-function stripPublishQuiet(cucumberConfig) {
-  const cucumberVersion = (0, _utils.getPackageVersion)('@cucumber/cucumber');
-  // Playwright-bdd supports Cucumber from v9+
-  // publishQuiet was deprecated in Cucumber 9.4.0.
-  // See: https://github.com/cucumber/cucumber-js/pull/2311
-  // Remove publishQuite from Cucumber config to hide deprecation warning.
-  // See: https://github.com/vitalets/playwright-bdd/pull/47
-  if (!/^9\.[0123]\./.test(cucumberVersion)) {
-    delete cucumberConfig.publishQuiet;
-  }
-}

package/build/bdd-framework/cucumber/buildStepDefinition.js

@@ -1,43 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildStepDefinition = buildStepDefinition;
-var _messages = require("@cucumber/messages");
-var _cucumberExpressions = require("@cucumber/cucumber-expressions");
-var _step_definition = _interopRequireDefault(require("@cucumber/cucumber/lib/models/step_definition"));
-/**
- * Extracted from cucumber SupportCodeLibraryBuilder.
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/support_code_library_builder/index.ts
- */
-
-const newId = _messages.IdGenerator.uuid();
-function buildStepDefinition({
-  keyword,
-  pattern,
-  code,
-  line,
-  options,
-  uri
-}, supportCodeLibrary) {
-  // todo: handle error.undefinedParameterTypeName as it's done in cucumber?
-  const expression = typeof pattern === 'string' ? new _cucumberExpressions.CucumberExpression(pattern, supportCodeLibrary.parameterTypeRegistry) : new _cucumberExpressions.RegularExpression(pattern, supportCodeLibrary.parameterTypeRegistry);
-  // skip wrapping code as it is not needed for decorator steps
-  // const wrappedCode = this.wrapCode({
-  //   code,
-  //   wrapperOptions: options.wrapperOptions,
-  // })
-  return new _step_definition.default({
-    code,
-    expression,
-    id: newId(),
-    line,
-    options,
-    keyword,
-    pattern,
-    unwrappedCode: code,
-    uri
-  });
-}

package/build/bdd-framework/cucumber/gherkin.d.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/build/bdd-framework/cucumber/gherkin.d.ts

@@ -1,45 +0,0 @@
-/**
- * Copied from @cucumber/cucumber/lib/api/gherkin.d.ts
- * Fixes error:
- * Return type of exported function has or is using name 'PickleWithDocument'
- * from external module "../node_modules/@cucumber/cucumber/lib/api/gherkin"
- * but cannot be named
- */
-import {
-  Envelope,
-  GherkinDocument,
-  IdGenerator,
-  Location,
-  ParseError,
-  Pickle,
-} from '@cucumber/messages';
-import { ISourcesCoordinates } from '@cucumber/cucumber/lib/api/types';
-import { ILogger } from '@cucumber/cucumber/lib/logger';
-
-declare module '@cucumber/cucumber/lib/api/gherkin' {
-  export interface PickleWithDocument {
-    gherkinDocument: GherkinDocument;
-    location: Location;
-    pickle: Pickle;
-  }
-  export 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[];
-  }>;
-}