imitial commit for esm migration

Author: DavertMik

.cursor/README.md

@@ -1,8 +1,11 @@
 #!/usr/bin/env node
-const program = require('commander')
-const Codecept = require('../lib/codecept')
-const { print, error } = require('../lib/output')
-const { printError } = require('../lib/command/utils')
+import { Command } from 'commander'
+const program = new Command()
+import Codecept from '../lib/codecept.js'
+import output from '../lib/output.js'
+const { print, error } = output
+import commandUtils from '../lib/command/utils.js'
+const { printError } = commandUtils
 
 const commandFlags = {
   ai: {
@@ -42,6 +45,23 @@ const errorHandler =
     }
   }
 
+const dynamicImport = async modulePath => {
+  const module = await import(modulePath)
+  return module.default || module
+}
+
+const commandHandler = modulePath =>
+  errorHandler(async (...args) => {
+    const handler = await dynamicImport(modulePath)
+    return handler(...args)
+  })
+
+const commandHandlerWithProperty = (modulePath, property) =>
+  errorHandler(async (...args) => {
+    const module = await dynamicImport(modulePath)
+    return module[property](...args)
+  })
+
 if (process.versions.node && process.versions.node.split('.') && process.versions.node.split('.')[0] < 12) {
   error('NodeJS >= 12 is required to run.')
   print()
@@ -53,22 +73,16 @@ if (process.versions.node && process.versions.node.split('.') && process.version
 program.usage('<command> [options]')
 program.version(Codecept.version())
 
-program
-  .command('init [path]')
-  .description('Creates dummy config in current dir or [path]')
-  .action(errorHandler(require('../lib/command/init')))
+program.command('init [path]').description('Creates dummy config in current dir or [path]').action(commandHandler('../lib/command/init.js'))
 
 program
   .command('check')
   .option(commandFlags.config.flag, commandFlags.config.description)
   .description('Checks configuration and environment before running tests')
   .option('-t, --timeout [ms]', 'timeout for checks in ms, 50000 by default')
-  .action(errorHandler(require('../lib/command/check')))
+  .action(commandHandler('../lib/command/check.js'))
 
-program
-  .command('migrate [path]')
-  .description('Migrate json config to js config in current dir or [path]')
-  .action(errorHandler(require('../lib/command/configMigrate')))
+program.command('migrate [path]').description('Migrate json config to js config in current dir or [path]').action(commandHandler('../lib/command/configMigrate.js'))
 
 program
   .command('shell [path]')
@@ -78,34 +92,30 @@ program
   .option(commandFlags.profile.flag, commandFlags.profile.description)
   .option(commandFlags.ai.flag, commandFlags.ai.description)
   .option(commandFlags.config.flag, commandFlags.config.description)
-  .action(errorHandler(require('../lib/command/interactive')))
+  .action(commandHandler('../lib/command/interactive.js'))
 
-program
-  .command('list [path]')
-  .alias('l')
-  .description('List all actions for I.')
-  .action(errorHandler(require('../lib/command/list')))
+program.command('list [path]').alias('l').description('List all actions for I.').action(commandHandler('../lib/command/list.js'))
 
 program
   .command('def [path]')
   .description('Generates TypeScript definitions for all I actions.')
   .option(commandFlags.config.flag, commandFlags.config.description)
   .option('-o, --output [folder]', 'target folder to paste definitions')
-  .action(errorHandler(require('../lib/command/definitions')))
+  .action(commandHandler('../lib/command/definitions.js'))
 
 program
   .command('gherkin:init [path]')
   .alias('bdd:init')
   .description('Prepare CodeceptJS to run feature files.')
   .option(commandFlags.config.flag, commandFlags.config.description)
-  .action(errorHandler(require('../lib/command/gherkin/init')))
+  .action(commandHandler('../lib/command/gherkin/init.js'))
 
 program
   .command('gherkin:steps [path]')
   .alias('bdd:steps')
   .description('Prints all defined gherkin steps.')
   .option(commandFlags.config.flag, commandFlags.config.description)
-  .action(errorHandler(require('../lib/command/gherkin/steps')))
+  .action(commandHandler('../lib/command/gherkin/steps.js'))
 
 program
   .command('gherkin:snippets [path]')
@@ -115,38 +125,22 @@ program
   .option(commandFlags.config.flag, commandFlags.config.description)
   .option('--feature [file]', 'feature files(s) to scan')
   .option('--path [file]', 'file in which to place the new snippets')
-  .action(errorHandler(require('../lib/command/gherkin/snippets')))
+  .action(commandHandler('../lib/command/gherkin/snippets.js'))
 
-program
-  .command('generate:test [path]')
-  .alias('gt')
-  .description('Generates an empty test')
-  .action(errorHandler(require('../lib/command/generate').test))
+program.command('generate:test [path]').alias('gt').description('Generates an empty test').action(commandHandlerWithProperty('../lib/command/generate.js', 'test'))
 
-program
-  .command('generate:pageobject [path]')
-  .alias('gpo')
-  .description('Generates an empty page object')
-  .action(errorHandler(require('../lib/command/generate').pageObject))
+program.command('generate:pageobject [path]').alias('gpo').description('Generates an empty page object').action(commandHandlerWithProperty('../lib/command/generate.js', 'pageObject'))
 
 program
   .command('generate:object [path]')
   .alias('go')
   .option('--type, -t [kind]', 'type of object to be created')
   .description('Generates an empty support object (page/step/fragment)')
-  .action(errorHandler(require('../lib/command/generate').pageObject))
+  .action(commandHandlerWithProperty('../lib/command/generate.js', 'pageObject'))
 
-program
-  .command('generate:helper [path]')
-  .alias('gh')
-  .description('Generates a new helper')
-  .action(errorHandler(require('../lib/command/generate').helper))
+program.command('generate:helper [path]').alias('gh').description('Generates a new helper').action(commandHandlerWithProperty('../lib/command/generate.js', 'helper'))
 
-program
-  .command('generate:heal [path]')
-  .alias('gr')
-  .description('Generates basic heal recipes')
-  .action(errorHandler(require('../lib/command/generate').heal))
+program.command('generate:heal [path]').alias('gr').description('Generates basic heal recipes').action(commandHandlerWithProperty('../lib/command/generate.js', 'heal'))
 
 program
   .command('run [test]')
@@ -185,7 +179,7 @@ program
   .option('--recursive', 'include sub directories')
   .option('--trace', 'trace function calls')
   .option('--child <string>', 'option for child processes')
-  .action(errorHandler(require('../lib/command/run')))
+  .action(commandHandler('../lib/command/run.js'))
 
 program
   .command('run-workers <workers> [selectedRuns...]')
@@ -204,7 +198,7 @@ program
   .option('-p, --plugins <k=v,k2=v2,...>', 'enable plugins, comma-separated')
   .option('-O, --reporter-options <k=v,k2=v2,...>', 'reporter-specific options')
   .option('-R, --reporter <name>', 'specify the reporter to use')
-  .action(errorHandler(require('../lib/command/run-workers')))
+  .action(commandHandler('../lib/command/run-workers.js'))
 
 program
   .command('run-multiple [suites...]')
@@ -230,13 +224,9 @@ program
   // mocha options
   .option('--colors', 'force enabling of colors')
 
-  .action(errorHandler(require('../lib/command/run-multiple')))
+  .action(commandHandler('../lib/command/run-multiple.js'))
 
-program
-  .command('info [path]')
-  .description('Print debugging information concerning the local environment')
-  .option('-c, --config', 'your config file path')
-  .action(errorHandler(require('../lib/command/info')))
+program.command('info [path]').description('Print debugging information concerning the local environment').option('-c, --config', 'your config file path').action(commandHandler('../lib/command/info.js'))
 
 program
   .command('dry-run [test]')
@@ -253,7 +243,7 @@ program
   .option(commandFlags.steps.flag, commandFlags.steps.description)
   .option(commandFlags.verbose.flag, commandFlags.verbose.description)
   .option(commandFlags.debug.flag, commandFlags.debug.description)
-  .action(errorHandler(require('../lib/command/dryRun')))
+  .action(commandHandler('../lib/command/dryRun.js'))
 
 program
   .command('run-rerun [test]')
@@ -291,7 +281,10 @@ program
   .option('--trace', 'trace function calls')
   .option('--child <string>', 'option for child processes')
 
-  .action(require('../lib/command/run-rerun'))
+  .action(async (...args) => {
+    const runRerun = await dynamicImport('../lib/command/run-rerun.js')
+    return runRerun(...args)
+  })
 
 program.on('command:*', cmd => {
   console.log(`\nUnknown command ${cmd}\n`)

.cursor/mcp.json

@@ -5,6 +5,11 @@ export const config = {
     CustomHelper: {
       require: './helpers/CustomHelper.js',
     },
+    FileSystem: {},
+    REST: {
+      endpoint: 'https://jsonplaceholder.typicode.com',
+      prettyPrintJson: true,
+    },
   },
   name: 'codeceptjs-esm-example',
 }

bin/codecept.js

@@ -1,6 +1,4 @@
-import { createRequire } from 'module'
-const require = createRequire(import.meta.url)
-const { Helper } = require('codeceptjs')
+import Helper from '@codeceptjs/helper'
 import assert from 'assert'
 
 class CustomHelper extends Helper {

example-esm/codecept.conf.js

@@ -9,7 +9,9 @@
     "test:verbose": "codeceptjs run --verbose"
   },
   "dependencies": {
-    "codeceptjs": "file:.."
+    "codeceptjs": "file:..",
+    "axios": "^1.6.0",
+    "joi": "^17.11.0"
   },
   "devDependencies": {},
   "engines": {

example-esm/helpers/CustomHelper.js

@@ -1,14 +1,12 @@
-const Step = require('./step')
-const MetaStep = require('./step/meta')
-const recordStep = require('./step/record')
-const container = require('./container')
-const { methodsOfObject } = require('./utils')
-const { TIMEOUT_ORDER } = require('./timeout')
-const eventModule = require('./event')
-const event = eventModule.default || eventModule
-const store = require('./store')
-const outputModule = require('./output')
-const output = outputModule.default || outputModule
+import Step, { MetaStep } from './step.js'
+import recordStep from './step/record.js'
+import retryStep from './step/retry.js'
+import { methodsOfObject } from './utils.js'
+import { TIMEOUT_ORDER } from './timeout.js'
+import event from './event.js'
+import storeModule from './store.js'
+const store = storeModule.default || storeModule
+import output from './output.js'
 
 /**
  * @interface
@@ -61,7 +59,6 @@ class Actor {
    */
   retry(opts) {
     console.log('I.retry() is deprecated, use step.retry() instead')
-    const retryStep = require('./step/retry')
     retryStep(opts)
     return this
   }
@@ -73,7 +70,7 @@ class Actor {
  * Wraps helper methods into promises.
  * @ignore
  */
-module.exports = function (obj = {}) {
+export default function (obj = {}, container) {
   const actor = container.actor() || new Actor()
 
   // load all helpers once container initialized

example-esm/package.json

@@ -1,9 +1,10 @@
-const debug = require('debug')('codeceptjs:ai')
-const outputModule = require('./output')
+import debugModule from 'debug'
+const debug = debugModule('codeceptjs:ai')
+import outputModule from './output.js'
 const output = outputModule.default || outputModule
-const eventModule = require('./event')
+import eventModule from './event.js'
 const event = eventModule.default || eventModule
-const { removeNonInteractiveElements, minifyHtml, splitByChunks } = require('./html')
+import { removeNonInteractiveElements, minifyHtml, splitByChunks } from './html.js'
 
 const defaultHtmlConfig = {
   maxLength: 50000,
@@ -306,4 +307,4 @@ function parseCodeBlocks(response) {
   return modifiedSnippets.filter(snippet => !!snippet)
 }
 
-module.exports = new AiAssistant()
+export default new AiAssistant()