codeceptjs 3.7.6-beta.4 → 4.0.0-beta.10.esm-aria

package/lib/command/check.js

@@ -1,15 +1,15 @@
-const { getConfig, getTestRoot } = require('./utils')
-const Codecept = require('../codecept')
-const output = require('../output')
-const store = require('../store')
-const container = require('../container')
-const figures = require('figures')
-const chalk = require('chalk')
-const { createTest } = require('../mocha/test')
-const { getMachineInfo } = require('./info')
-const definitions = require('./definitions')
-
-module.exports = async function (options) {
+import { getConfig, getTestRoot } from './utils.js'
+import Codecept from '../codecept.js'
+import output from '../output.js'
+import store from '../store.js'
+import Container from '../container.js'
+import figures from 'figures'
+import chalk from 'chalk'
+import { createTest } from '../mocha/test.js'
+import { getMachineInfo } from './info.js'
+import definitions from './definitions.js'
+
+export default async function (options) {
   const configFile = options.config
 
   setTimeout(() => {
@@ -31,10 +31,10 @@ module.exports = async function (options) {
   }
 
   const testRoot = getTestRoot(configFile)
-  let config = getConfig(configFile)
+  let config = await getConfig(configFile)
 
   try {
-    config = getConfig(configFile)
+    config = await getConfig(configFile)
     checks['config'] = true
   } catch (err) {
     checks['config'] = err
@@ -45,14 +45,14 @@ module.exports = async function (options) {
   let codecept
   try {
     codecept = new Codecept(config, options)
-    codecept.init(testRoot)
-    await container.started()
+    await codecept.init(testRoot)
+    await Container.started()
     checks.container = true
   } catch (err) {
     checks.container = err
   }
 
-  const standardActingHelpers = container.STANDARD_ACTING_HELPERS
+  const standardActingHelpers = Container.STANDARD_ACTING_HELPERS
 
   printCheck('container', checks['container'])
 
@@ -70,12 +70,17 @@ module.exports = async function (options) {
   if (codecept) {
     try {
       codecept.loadTests()
-      const mocha = container.mocha()
-      mocha.files = codecept.testFiles
+      const files = codecept.testFiles
+      const mocha = Container.mocha()
+      mocha.files = files
       mocha.loadFiles()
-      mocha.suite.suites.forEach(suite => {
-        numTests += suite.tests.length
-      })
+
+      for (const suite of mocha.suite.suites) {
+        if (suite && suite.tests) {
+          numTests += suite.tests.length
+        }
+      }
+
       if (numTests > 0) {
         checks.tests = true
       } else {
@@ -97,13 +102,13 @@ module.exports = async function (options) {
 
   store.dryRun = true
 
-  const helpers = container.helpers()
+  const helpers = Container.helpers()
 
   try {
     if (!Object.keys(helpers).length) throw new Error('No helpers found')
     // load helpers
     for (const helper of Object.values(helpers)) {
-      if (helper._init) helper._init()
+      if (helper._init) await helper._init()
     }
     checks.helpers = true
   } catch (err) {
@@ -112,7 +117,7 @@ module.exports = async function (options) {
 
   printCheck('helpers', checks['helpers'], `${Object.keys(helpers).join(', ')}`)
 
-  const pageObjects = container.support()
+  const pageObjects = Container.support()
 
   try {
     if (Object.keys(pageObjects).length) {
@@ -127,10 +132,10 @@ module.exports = async function (options) {
   printCheck('page objects', checks['pageObjects'], `Total: ${Object.keys(pageObjects).length} support objects`)
 
   checks.plugins = true // how to check plugins?
-  printCheck('plugins', checks['plugins'], Object.keys(container.plugins()).join(', '))
+  printCheck('plugins', checks['plugins'], Object.keys(Container.plugins()).join(', '))
 
   if (Object.keys(helpers).length) {
-    const suite = container.mocha().suite
+    const suite = Container.mocha().suite
     const test = createTest('test', () => {})
     checks.setup = true
     for (const helper of Object.values(helpers)) {

package/lib/command/configMigrate.js

@@ -1,15 +1,16 @@
-const colors = require('chalk')
-const fs = require('fs')
-const inquirer = require('inquirer')
-const mkdirp = require('mkdirp')
-const path = require('path')
-const util = require('util')
+import colors from 'chalk'
+import fs from 'fs'
+import inquirer from 'inquirer'
+import { mkdirp } from 'mkdirp'
+import path from 'path'
+import util from 'util'
 
-const { print, success, error } = require('../output')
-const { fileExists } = require('../utils')
-const { getTestRoot } = require('./utils')
+import output from '../output.js'
+const { print, success, error } = output
+import { fileExists } from '../utils.js'
+import { getTestRoot } from './utils.js'
 
-module.exports = function (initPath) {
+export default function (initPath) {
   const testsPath = getTestRoot(initPath)
 
   print()

package/lib/command/definitions.js

@@ -1,10 +1,10 @@
-const fs = require('fs')
-const path = require('path')
+import fs from 'fs'
+import path from 'path'
 
-const { getConfig, getTestRoot } = require('./utils')
-const Codecept = require('../codecept')
-const container = require('../container')
-const output = require('../output')
+import { getConfig, getTestRoot } from './utils.js'
+import Codecept from '../codecept.js'
+import container from '../container.js'
+import output from '../output.js'
 const actingHelpers = [...container.STANDARD_ACTING_HELPERS, 'REST']
 
 /**
@@ -86,11 +86,11 @@ const helperNames = []
 /** @type {Array<string>} */
 const customHelpers = []
 
-module.exports = function (genPath, options) {
+export default async function (genPath, options) {
   const configFile = options.config || genPath
   /** @type {string} */
   const testsPath = getTestRoot(configFile)
-  const config = getConfig(configFile)
+  const config = await getConfig(configFile)
   if (!config) return
 
   /** @type {Object<string, string>} */
@@ -106,7 +106,8 @@ module.exports = function (genPath, options) {
   const targetFolderPath = (options.output && getTestRoot(options.output)) || testsPath
 
   const codecept = new Codecept(config, {})
-  codecept.init(testsPath)
+  await codecept.init(testsPath)
+  await container.started()
 
   const helpers = container.helpers()
   const translations = container.translation()
@@ -229,7 +230,12 @@ function getImportString(testsPath, targetFolderPath, pathsToType, pathsToValue)
 
   for (const name in pathsToType) {
     const relativePath = getPath(pathsToType[name], targetFolderPath, testsPath)
-    importStrings.push(`type ${name} = typeof import('${relativePath}');`)
+    // For ESM modules with default exports, we need to access the default export type
+    if (relativePath.endsWith('.js')) {
+      importStrings.push(`type ${name} = typeof import('${relativePath}')['default'];`)
+    } else {
+      importStrings.push(`type ${name} = typeof import('${relativePath}');`)
+    }
   }
 
   for (const name in pathsToValue) {

package/lib/command/dryRun.js

@@ -1,18 +1,18 @@
-const { getConfig, getTestRoot } = require('./utils')
-const Config = require('../config')
-const Codecept = require('../codecept')
-const output = require('../output')
-const event = require('../event')
-const store = require('../store')
-const Container = require('../container')
-
-module.exports = async function (test, options) {
+import { getConfig, getTestRoot } from './utils.js'
+import Config from '../config.js'
+import Codecept from '../codecept.js'
+import output from '../output.js'
+import event from '../event.js'
+import store from '../store.js'
+import Container from '../container.js'
+
+export default async function (test, options) {
   if (options.grep) process.env.grep = options.grep
   const configFile = options.config
   let codecept
 
   const testRoot = getTestRoot(configFile)
-  let config = getConfig(configFile)
+  let config = await getConfig(configFile)
   if (options.override) {
     config = Config.append(JSON.parse(options.override))
   }
@@ -27,7 +27,7 @@ module.exports = async function (test, options) {
 
   try {
     codecept = new Codecept(config, options)
-    codecept.init(testRoot)
+    await codecept.init(testRoot)
 
     if (options.bootstrap) await codecept.bootstrap()
 
@@ -35,20 +35,20 @@ module.exports = async function (test, options) {
     store.dryRun = true
 
     if (!options.steps && !options.verbose && !options.debug) {
-      printTests(codecept.testFiles)
+      await printTests(codecept.testFiles)
       return
     }
     event.dispatcher.on(event.all.result, printFooter)
-    codecept.run(test)
+    await codecept.run(test)
   } catch (err) {
     console.error(err)
     process.exit(1)
   }
 }
 
-function printTests(files) {
-  const figures = require('figures')
-  const colors = require('chalk')
+async function printTests(files) {
+  const { default: figures } = await import('figures')
+  const { default: colors } = await import('chalk')
 
   output.print(output.styles.debug(`Tests from ${global.codecept_dir}:`))
   output.print()

package/lib/command/generate.js

@@ -1,12 +1,12 @@
-const colors = require('chalk')
-const fs = require('fs')
-const inquirer = require('inquirer')
-const mkdirp = require('mkdirp')
-const path = require('path')
-const { fileExists, ucfirst, lcfirst, beautify } = require('../utils')
-const output = require('../output')
-const generateDefinitions = require('./definitions')
-const { getConfig, getTestRoot, safeFileWrite, readConfig } = require('./utils')
+import colors from 'chalk'
+import fs from 'fs'
+import inquirer from 'inquirer'
+import { mkdirp } from 'mkdirp'
+import path from 'path'
+import { fileExists, ucfirst, lcfirst, beautify } from '../utils.js'
+import output from '../output.js'
+import generateDefinitions from './definitions.js'
+import { getConfig, getTestRoot, safeFileWrite, readConfig } from './utils.js'
 
 let extension = 'js'
 
@@ -18,10 +18,10 @@ Scenario('test something', async ({ {{actor}} }) => {
 `
 
 // generates empty test
-module.exports.test = function (genPath) {
+export async function test(genPath) {
   const testsPath = getTestRoot(genPath)
   global.codecept_dir = testsPath
-  const config = getConfig(testsPath)
+  const config = await getConfig(testsPath)
   if (!config) return
 
   output.print('Creating a new test...')
@@ -46,7 +46,7 @@ module.exports.test = function (genPath) {
         },
       },
     ])
-    .then(result => {
+    .then(async result => {
       const testFilePath = path.dirname(path.join(testsPath, config.tests)).replace(/\*\*$/, '')
       let testFile = path.join(testFilePath, result.filename)
       const ext = path.extname(testFile)
@@ -55,8 +55,9 @@ module.exports.test = function (genPath) {
       if (!fileExists(dir)) mkdirp.sync(dir)
       let testContent = testTemplate.replace('{{feature}}', result.feature)
 
-      const container = require('../container')
-      container.create(config, {})
+      const containerModule = await import('../container.js')
+      const container = containerModule.default || containerModule
+      await container.create(config, {})
       // translate scenario test
       if (container.translation().loaded) {
         const vocabulary = container.translation().vocabulary
@@ -76,7 +77,7 @@ module.exports.test = function (genPath) {
 
 const pageObjectTemplate = `const { I } = inject();
 
-module.exports = {
+export default {
 
   // insert your locators and methods here
 }
@@ -101,13 +102,13 @@ class {{name}} {
 }
 
 // For inheritance
-module.exports = new {{name}}();
-export = {{name}};
+export default new {{name}}();
+export { {{name}} };
 `
 
-module.exports.pageObject = function (genPath, opts) {
+export async function pageObject(genPath, opts) {
   const testsPath = getTestRoot(genPath)
-  const config = getConfig(testsPath)
+  const config = await getConfig(testsPath)
   const kind = opts.T || 'page'
   if (!config) return
 
@@ -155,7 +156,7 @@ module.exports.pageObject = function (genPath, opts) {
           // relative path
           actorPath = path.relative(dir, path.dirname(path.join(testsPath, actorPath))) + actorPath.substring(1) // get an upper level
         }
-        actor = `require('${actorPath}')`
+        actor = `import('${actorPath}')`
       }
 
       const name = lcfirst(result.name) + ucfirst(kind)
@@ -197,7 +198,7 @@ module.exports.pageObject = function (genPath, opts) {
     })
 }
 
-const helperTemplate = `const Helper = require('@codeceptjs/helper');
+const helperTemplate = `import Helper from '@codeceptjs/helper';
 
 class {{name}} extends Helper {
 
@@ -222,10 +223,10 @@ class {{name}} extends Helper {
 
 }
 
-module.exports = {{name}};
+export default {{name}};
 `
 
-module.exports.helper = function (genPath) {
+export async function helper(genPath) {
   const testsPath = getTestRoot(genPath)
 
   output.print('Creating a new helper')
@@ -265,9 +266,11 @@ helpers: {
     })
 }
 
+import { fileURLToPath } from 'url'
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
 const healTemplate = fs.readFileSync(path.join(__dirname, '../template/heal.js'), 'utf8').toString()
 
-module.exports.heal = function (genPath) {
+export async function heal(genPath) {
   const testsPath = getTestRoot(genPath)
 
   let configFile = path.join(testsPath, `codecept.conf.${extension}`)
@@ -282,10 +285,10 @@ module.exports.heal = function (genPath) {
   output.print('Require this file in the config file and enable heal plugin:')
   output.print('--------------------------')
   output.print(`
-require('./heal')
+import './heal.js'
 
-exports.config = {
-  // ... 
+export const config = {
+  // ...
   plugins: {
     heal: {
       enabled: true
@@ -298,3 +301,35 @@ exports.config = {
   if (!safeFileWrite(healFile, healTemplate)) return
   output.success(`Heal recipes were created in ${healFile}`)
 }
+
+export async function prompt(promptName, genPath) {
+  if (!promptName) {
+    output.error('Please specify prompt name: writeStep, healStep, or generatePageObject')
+    output.print('Usage: npx codeceptjs generate:prompt <promptName>')
+    return
+  }
+
+  const validPrompts = ['writeStep', 'healStep', 'generatePageObject']
+  if (!validPrompts.includes(promptName)) {
+    output.error(`Invalid prompt name: ${promptName}`)
+    output.print(`Valid prompts: ${validPrompts.join(', ')}`)
+    return
+  }
+
+  const testsPath = getTestRoot(genPath)
+
+  const promptsDir = path.join(testsPath, 'prompts')
+  if (!fileExists(promptsDir)) {
+    mkdirp.sync(promptsDir)
+  }
+
+  const templatePath = path.join(__dirname, `../template/prompts/${promptName}.js`)
+  const promptContent = fs.readFileSync(templatePath, 'utf8')
+
+  const promptFile = path.join(promptsDir, `${promptName}.${extension}`)
+  if (!safeFileWrite(promptFile, promptContent)) return
+
+  output.success(`Prompt ${promptName} was created in ${promptFile}`)
+  output.print('Customize this prompt to fit your needs.')
+  output.print('This prompt will be automatically loaded when AI features are enabled.')
+}

package/lib/command/gherkin/init.js

@@ -1,11 +1,9 @@
-const path = require('path');
-const mkdirp = require('mkdirp');
+import path from 'path'
+import { mkdirp } from 'mkdirp'
 
-const output = require('../../output');
-const { fileExists } = require('../../utils');
-const {
-  getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile,
-} = require('../utils');
+import output from '../../output.js'
+import { fileExists } from '../../utils.js'
+import { getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile } from '../utils.js'
 
 const featureFile = `Feature: Business rules
   In order to achieve my goals
@@ -14,7 +12,7 @@ const featureFile = `Feature: Business rules
 
   Scenario: do something
     Given I have a defined step
-`;
+`
 
 const stepsFile = `const { I } = inject();
 // Add in your custom step files
@@ -22,60 +20,60 @@ const stepsFile = `const { I } = inject();
 Given('I have a defined step', () => {
   // TODO: replace with your own step
 });
-`;
+`
 
-module.exports = function (genPath) {
-  const testsPath = getTestRoot(genPath);
-  const configFile = findConfigFile(testsPath);
+export default async function (genPath) {
+  const testsPath = getTestRoot(genPath)
+  const configFile = findConfigFile(testsPath)
 
   if (!configFile) {
-    output.error(
-      "Can't initialize Gherkin. This command must be run in an already initialized project.",
-    );
-    process.exit(1);
+    output.error("Can't initialize Gherkin. This command must be run in an already initialized project.")
+    process.exit(1)
   }
 
-  const config = getConfig(testsPath);
-  const extension = path.extname(configFile).substring(1);
+  const config = await getConfig(testsPath)
+  const extension = path.extname(configFile).substring(1)
 
-  output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS');
-  output.print('--------------------------');
+  output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS')
+  output.print('--------------------------')
 
   if (config.gherkin && config.gherkin.steps) {
-    output.error('Gherkin is already initialized in this project. See `gherkin` section in the config');
-    process.exit(1);
+    output.error('Gherkin is already initialized in this project. See `gherkin` section in the config')
+    process.exit(1)
   }
 
-  let dir;
-  dir = path.join(testsPath, 'features');
+  let dir
+  dir = path.join(testsPath, 'features')
   if (!fileExists(dir)) {
-    mkdirp.sync(dir);
-    output.success(`Created ${dir}, place your *.feature files in it`);
+    mkdirp.sync(dir)
+    // Use relative path for output
+    const relativeDir = path.relative(process.cwd(), dir)
+    output.success(`Created ${relativeDir}, place your *.feature files in it`)
   }
 
   if (safeFileWrite(path.join(dir, 'basic.feature'), featureFile)) {
-    output.success('Created sample feature file: features/basic.feature');
+    output.success('Created sample feature file: features/basic.feature')
   }
 
-  dir = path.join(testsPath, 'step_definitions');
+  dir = path.join(testsPath, 'step_definitions')
   if (!fileExists(dir)) {
-    mkdirp.sync(dir);
-    output.success(`Created ${dir}, place step definitions into it`);
+    mkdirp.sync(dir)
+    // Use relative path for output
+    const relativeDir = path.relative(process.cwd(), dir)
+    output.success(`Created ${relativeDir}, place step definitions into it`)
   }
 
   if (safeFileWrite(path.join(dir, `steps.${extension}`), stepsFile)) {
-    output.success(
-      `Created sample steps file: step_definitions/steps.${extension}`,
-    );
+    output.success(`Created sample steps file: step_definitions/steps.${extension}`)
   }
 
   config.gherkin = {
     features: './features/*.feature',
     steps: [`./step_definitions/steps.${extension}`],
-  };
+  }
 
-  updateConfig(testsPath, config, extension);
+  updateConfig(testsPath, config, extension)
 
-  output.success('Gherkin setup is done.');
-  output.success('Start writing feature files and implement corresponding steps.');
-};
+  output.success('Gherkin setup is done.')
+  output.success('Start writing feature files and implement corresponding steps.')
+}

package/lib/command/gherkin/snippets.js

@@ -1,29 +1,29 @@
-const escapeStringRegexp = require('escape-string-regexp')
-const fs = require('fs')
-const Gherkin = require('@cucumber/gherkin')
-const Messages = require('@cucumber/messages')
-const { globSync } = require('glob')
-const fsPath = require('path')
+import escapeStringRegexp from 'escape-string-regexp'
+import fs from 'fs'
+import Gherkin from '@cucumber/gherkin'
+import { IdGenerator } from '@cucumber/messages'
+import { globSync } from 'glob'
+import fsPath from 'path'
 
-const { getConfig, getTestRoot } = require('../utils')
-const Codecept = require('../../codecept')
-const output = require('../../output')
-const { matchStep } = require('../../mocha/bdd')
+import { getConfig, getTestRoot } from '../utils.js'
+import Codecept from '../../codecept.js'
+import output from '../../output.js'
+import { matchStep } from '../../mocha/bdd.js'
 
-const uuidFn = Messages.IdGenerator.uuid()
+const uuidFn = IdGenerator.uuid()
 const builder = new Gherkin.AstBuilder(uuidFn)
 const matcher = new Gherkin.GherkinClassicTokenMatcher()
 const parser = new Gherkin.Parser(builder, matcher)
 parser.stopAtFirstError = false
 
-module.exports = function (genPath, options) {
+export default async function (genPath, options) {
   const configFile = options.config || genPath
   const testsPath = getTestRoot(configFile)
-  const config = getConfig(configFile)
+  const config = await getConfig(configFile)
   if (!config) return
 
   const codecept = new Codecept(config, {})
-  codecept.init(testsPath)
+  await codecept.init(testsPath)
 
   if (!config.gherkin) {
     output.error('Gherkin is not enabled in config. Run `codecept gherkin:init` to enable it')

package/lib/command/gherkin/steps.js

@@ -1,25 +1,28 @@
-const { getConfig, getTestRoot } = require('../utils');
-const Codecept = require('../../codecept');
-const output = require('../../output');
-const { getSteps } = require('../../mocha/bdd');
+import { getConfig, getTestRoot } from '../utils.js'
+import Codecept from '../../codecept.js'
+import output from '../../output.js'
+import { getSteps, clearSteps } from '../../mocha/bdd.js'
 
-module.exports = function (genPath, options) {
-  const configFile = options.config || genPath;
-  const testsPath = getTestRoot(configFile);
-  const config = getConfig(configFile);
-  if (!config) return;
+export default async function (genPath, options) {
+  const configFile = options.config || genPath
+  const testsPath = getTestRoot(configFile)
+  const config = await getConfig(configFile)
+  if (!config) return
 
-  const codecept = new Codecept(config, {});
-  codecept.init(testsPath);
+  // Clear any previously loaded steps
+  clearSteps()
+  
+  const codecept = new Codecept(config, {})
+  await codecept.init(testsPath)
 
-  output.print('Gherkin Step Definitions:');
-  output.print();
-  const steps = getSteps();
+  output.print('Gherkin Step Definitions:')
+  output.print()
+  const steps = getSteps()
   for (const step of Object.keys(steps)) {
-    output.print(`  ${output.colors.bold(step)} ${output.colors.green(steps[step].line || '')}`);
+    output.print(`  ${output.colors.bold(step)} ${output.colors.green(steps[step].line || '')}`)
   }
-  output.print();
+  output.print()
   if (!Object.keys(steps).length) {
-    output.error('No Gherkin steps defined');
+    output.error('No Gherkin steps defined')
   }
-};
+}