codeceptjs 4.0.0-beta.18 → 4.0.0-beta.19

package/lib/codecept.js

@@ -3,8 +3,9 @@ import { globSync } from 'glob'
 import shuffle from 'lodash.shuffle'
 import fsPath from 'path'
 import { resolve } from 'path'
-import { fileURLToPath } from 'url'
+import { fileURLToPath, pathToFileURL } from 'url'
 import { dirname } from 'path'
+import { createRequire } from 'module'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
@@ -18,6 +19,7 @@ import ActorFactory from './actor.js'
 import output from './output.js'
 import { emptyFolder } from './utils.js'
 import { initCodeceptGlobals } from './globals.js'
+import { validateTypeScriptSetup } from './utils/loaderCheck.js'
 import recorder from './recorder.js'
 
 import storeListener from './listener/store.js'
@@ -66,6 +68,21 @@ class Codecept {
               modulePath = `${modulePath}.js`
             }
           }
+        } else {
+          // For npm packages, resolve from the user's directory
+          // This ensures packages like tsx are found in user's node_modules
+          const userDir = global.codecept_dir || process.cwd()
+          
+          try {
+            // Use createRequire to resolve from user's directory
+            const userRequire = createRequire(pathToFileURL(resolve(userDir, 'package.json')).href)
+            const resolvedPath = userRequire.resolve(requiredModule)
+            modulePath = pathToFileURL(resolvedPath).href
+          } catch (resolveError) {
+            // If resolution fails, try direct import (will check from CodeceptJS node_modules)
+            // This is the fallback for globally installed packages
+            modulePath = requiredModule
+          }
         }
         // Use dynamic import for ESM
         await import(modulePath)
@@ -246,6 +263,13 @@ class Codecept {
   async run(test) {
     await container.started()
 
+    // Check TypeScript loader configuration before running tests
+    const tsValidation = validateTypeScriptSetup(this.testFiles, this.requiringModules || [])
+    if (tsValidation.hasError) {
+      output.error(tsValidation.message)
+      process.exit(1)
+    }
+
     // Ensure translations are loaded for Gherkin features
     try {
       const { loadTranslations } = await import('./mocha/gherkin.js')

package/lib/command/init.js

@@ -161,7 +161,7 @@ export default async function (initPath) {
         isTypeScript = true
         extension = isTypeScript === true ? 'ts' : 'js'
         packages.push('typescript')
-        packages.push('ts-node')
+        packages.push('tsx')  // Add tsx for TypeScript support
         packages.push('@types/node')
       }
 
@@ -172,6 +172,7 @@ export default async function (initPath) {
       config.tests = result.tests
       if (isTypeScript) {
         config.tests = `${config.tests.replace(/\.js$/, `.${extension}`)}`
+        config.require = ['tsx/cjs']  // Add tsx/cjs loader for TypeScript tests
       }
 
       // create a directory tests if it is included in tests path

package/lib/utils/loaderCheck.js

@@ -0,0 +1,124 @@
+/**
+ * Utilities for checking TypeScript loader availability
+ */
+
+/**
+ * Check if a TypeScript loader is available for test files
+ * Note: This checks if loaders are in the require array, not if packages are installed
+ * Package installation is checked when actually requiring modules
+ * @param {string[]} requiredModules - Array of required modules from config
+ * @returns {boolean}
+ */
+export function checkTypeScriptLoader(requiredModules = []) {
+  // Check if a loader is configured in the require array
+  return (
+    requiredModules.includes('tsx/esm') ||
+    requiredModules.includes('tsx/cjs') ||
+    requiredModules.includes('tsx') ||
+    requiredModules.includes('ts-node/esm') ||
+    requiredModules.includes('ts-node/register') ||
+    requiredModules.includes('ts-node')
+  )
+}
+
+/**
+ * Generate helpful error message if .ts tests found but no loader configured
+ * @param {string[]} testFiles - Array of test file paths
+ * @returns {string|null} Error message or null if no TypeScript files
+ */
+export function getTypeScriptLoaderError(testFiles) {
+  const tsFiles = testFiles.filter(f => f.endsWith('.ts'))
+
+  if (tsFiles.length === 0) return null
+
+  return `
+╔═════════════════════════════════════════════════════════════════════════════╗
+║                                                                             ║
+║  ⚠️  TypeScript Test Files Detected but No Loader Configured                ║
+║                                                                             ║
+╚═════════════════════════════════════════════════════════════════════════════╝
+
+Found ${tsFiles.length} TypeScript test file(s) but no TypeScript loader is configured.
+
+CodeceptJS 4.x uses ES Modules (ESM) and requires a loader to run TypeScript tests.
+
+┌─────────────────────────────────────────────────────────────────────────────┐
+│ Option 1: tsx (Recommended - Fast, Zero Config)                            │
+└─────────────────────────────────────────────────────────────────────────────┘
+
+  Installation:
+    npm install --save-dev tsx
+
+  Configuration:
+    Add to your codecept.conf.ts or codecept.conf.js:
+
+    export const config = {
+      tests: './**/*_test.ts',
+      require: ['tsx/cjs'],  // ← Add this line
+      helpers: { /* ... */ }
+    }
+
+  Why tsx?
+    ⚡ Fast: Built on esbuild
+    🎯 Zero config: No tsconfig.json required
+    ✅ Works with Mocha: Uses CommonJS hooks
+    ✅ Complete: Handles all TypeScript features
+
+┌─────────────────────────────────────────────────────────────────────────────┐
+│ Option 2: ts-node/esm (Alternative - Established, Requires Config)         │
+└─────────────────────────────────────────────────────────────────────────────┘
+
+  Installation:
+    npm install --save-dev ts-node
+
+  Configuration:
+    1. Add to your codecept.conf.ts:
+       require: ['ts-node/esm']
+
+    2. Create tsconfig.json:
+       {
+         "compilerOptions": {
+           "module": "ESNext",
+           "target": "ES2022",
+           "moduleResolution": "node",
+           "esModuleInterop": true
+         },
+         "ts-node": {
+           "esm": true,
+           "experimentalSpecifierResolution": "node"
+         }
+       }
+
+📚 Documentation: https://codecept.io/typescript
+
+Note: TypeScript config files (codecept.conf.ts) and helpers are automatically
+      transpiled. Only test files require a loader to be configured.
+`
+}
+
+/**
+ * Check if user is trying to run TypeScript tests without proper loader
+ * @param {string[]} testFiles - Array of test file paths
+ * @param {string[]} requiredModules - Array of required modules from config
+ * @returns {{hasError: boolean, message: string|null}}
+ */
+export function validateTypeScriptSetup(testFiles, requiredModules = []) {
+  const tsFiles = testFiles.filter(f => f.endsWith('.ts'))
+
+  if (tsFiles.length === 0) {
+    // No TypeScript test files, all good
+    return { hasError: false, message: null }
+  }
+
+  // Check if a loader is configured in the require array
+  const hasLoader = checkTypeScriptLoader(requiredModules)
+
+  if (hasLoader) {
+    // Loader configured, all good (package will be checked when requireModules runs)
+    return { hasError: false, message: null }
+  }
+
+  // No loader configured and TypeScript tests exist
+  const message = getTypeScriptLoaderError(testFiles)
+  return { hasError: true, message }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "4.0.0-beta.18",
+  "version": "4.0.0-beta.19",
   "type": "module",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
@@ -183,6 +183,7 @@
     "ts-node": "10.9.2",
     "tsd": "^0.33.0",
     "tsd-jsdoc": "2.5.0",
+    "tsx": "^4.19.2",
     "typedoc": "0.28.13",
     "typedoc-plugin-markdown": "4.9.0",
     "typescript": "5.8.3",
@@ -191,6 +192,14 @@
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },
+  "peerDependencies": {
+    "tsx": "^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "tsx": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=16.0",
     "npm": ">=5.6.0"