codeceptjs 4.0.0-rc.2 → 4.0.0-rc.20

package/README.md

@@ -1,7 +1,7 @@
 [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)
 
 [<img src="https://img.shields.io/badge/slack-@codeceptjs-purple.svg?logo=slack">](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [<img src="https://img.shields.io/badge/discourse-codeceptjs-purple">](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url] [<img src="https://img.shields.io/badge/dockerhub-images-blue.svg?logo=codeceptjs">](https://hub.docker.com/r/codeceptjs/codeceptjs)
-[![AI features](https://img.shields.io/badge/AI-features?logo=openai&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
+[![AI features](https://img.shields.io/badge/AI-features?logo=openai&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [![MCP Server](https://img.shields.io/badge/MCP-server?logo=anthropic&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/blob/main/docs/mcp.md) [![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
 
 ## Build Status
 
@@ -233,48 +233,60 @@ Scenario('test title', () => {
 })
 ```
 
-## HTML Reporter
+## HTML Reports
 
-CodeceptJS includes a powerful built-in HTML Reporter that generates comprehensive, interactive test reports with detailed information about your test runs. The HTML reporter is **enabled by default** for all new projects and provides:
+Generate beautiful HTML reports using **[@testomatio/reporter](https://github.com/testomatio/reporter)** package.
 
-### Features
-
-- **Interactive Dashboard**: Visual statistics, pie charts, and expandable test details
-- **Step-by-Step Execution**: Shows individual test steps with timing and status indicators
-- **BDD/Gherkin Support**: Full support for feature files with proper scenario formatting
-- **System Information**: Comprehensive environment details including browser versions
-- **Advanced Filtering**: Real-time filtering by status, tags, features, and test types
-- **History Tracking**: Multi-run history with trend visualization
-- **Error Details**: Clean formatting of error messages and stack traces
-- **Artifacts Support**: Display screenshots and other test artifacts
+### Installation
 
-### Visual Examples
+```sh
+npm install @testomatio/reporter --save-dev
+```
 
-#### Interactive Test Dashboard
+### Configuration
 
-The main dashboard provides a complete overview with interactive statistics and pie charts:
+Add the `testomatio` plugin to your `codecept.conf.js`:
 
-![HTML Reporter Dashboard](docs/shared/html-reporter-main-dashboard.png)
+```js
+plugins: {
+  testomatio: {
+    enabled: true,
+    require: '@testomatio/reporter/lib/adapter/codecept',
+  },
+}
+```
 
-#### Detailed Test Results
+### Usage
 
-Each test shows comprehensive execution details with expandable step information:
+Generate HTML reports by setting the `TESTOMATIO_HTML_REPORT_SAVE` environment variable:
 
-![HTML Reporter Test Details](docs/shared/html-reporter-test-details.png)
+```sh
+TESTOMATIO_HTML_REPORT_SAVE=1 npx codeceptjs run
+```
 
-#### Advanced Filtering Capabilities
+The report will be saved to `html-report/testomatio-report.html`.
 
-Real-time filtering allows quick navigation through test results:
+### Features
 
-![HTML Reporter Filtering](docs/shared/html-reporter-filtering.png)
+- Modern, responsive interface with real-time statistics
+- Detailed test information with step-by-step breakdown
+- Screenshots, videos, and artifacts display
+- BDD/Gherkin support with proper scenario formatting
+- Customizable output location and filename
+- Optional integration with [Testomat.io](https://testomat.io) cloud
 
-#### BDD/Gherkin Support
+### Customization
 
-Full support for Gherkin scenarios with proper feature formatting:
+```sh
+# Custom output folder
+TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO_HTML_REPORT_FOLDER=./reports npx codeceptjs run
 
-![HTML Reporter BDD Details](docs/shared/html-reporter-bdd-details.png)
+# Custom filename
+TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO_HTML_FILENAME=my-report.html npx codeceptjs run
 
-The HTML reporter generates self-contained reports that can be easily shared with your team. Learn more about configuration and features in the [HTML Reporter documentation](https://codecept.io/plugins/#htmlreporter).
+# Integrate with Testomat.io cloud
+TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO=your_api_key npx codeceptjs run
+```
 
 ## PageObjects
 

package/bin/codecept.js

@@ -72,7 +72,11 @@ 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(commandHandler('../lib/command/init.js'))
+program
+  .command('init [path]')
+  .description('Creates dummy config in current dir or [path]')
+  .option('-y, --yes', 'skip prompts and use defaults (Playwright + chromium, BASE_URL env for url)')
+  .action(commandHandler('../lib/command/init.js'))
 
 program
   .command('check')
@@ -93,7 +97,14 @@ program
   .option(commandFlags.config.flag, commandFlags.config.description)
   .action(commandHandler('../lib/command/interactive.js'))
 
-program.command('list [path]').alias('l').description('List all actions for I.').action(commandHandler('../lib/command/list.js'))
+program
+  .command('list [path]')
+  .alias('l')
+  .description('List all actions for I.')
+  .option(commandFlags.config.flag, commandFlags.config.description)
+  .option('--docs', 'show documentation for each action')
+  .option('--action <name>', 'show docs for a single action (e.g. amOnPage or I.amOnPage)')
+  .action(commandHandler('../lib/command/list.js'))
 
 program
   .command('def [path]')
@@ -251,6 +262,8 @@ program
   .option(commandFlags.steps.flag, commandFlags.steps.description)
   .option(commandFlags.verbose.flag, commandFlags.verbose.description)
   .option(commandFlags.debug.flag, commandFlags.debug.description)
+  .option('--no-ansi', 'disable colored / ANSI-styled output')
+  .option('--numbers', 'prefix each step with a per-test index number')
   .action(commandHandler('../lib/command/dryRun.js'))
 
 program

package/bin/codeceptq.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+import { Command } from 'commander'
+import query from '../lib/command/query.js'
+
+const program = new Command()
+
+program
+  .name('codeceptq')
+  .description('Query HTML with CodeceptJS locators (CSS, XPath, fuzzy text, semantic).\n\nReads HTML from stdin or --file and prints matching elements with line numbers.')
+  .argument('<locator>', 'locator string (CSS, XPath, or text for semantic match)')
+  .argument('[context]', 'scope locator — restrict matches to descendants of context')
+  .option('--field', 'treat locator as form field (input/textarea/select)')
+  .option('--click', 'treat locator as clickable element (link, button, role=button, ...)')
+  .option('--clickable', 'alias for --click')
+  .option('--checkable', 'treat locator as checkbox/radio')
+  .option('--select', 'treat locator as <option> visible text')
+  .option('--xpath', 'force XPath interpretation')
+  .option('--css', 'force CSS interpretation')
+  .option('--file <path>', 'read HTML from file instead of stdin')
+  .option('--limit <n>', 'cap matches printed', '20')
+  .option('--snippet <chars>', 'truncate outerHTML per match to N characters', '500')
+  .option('--full', 'print full outerHTML (no truncation)')
+  .option('--json', 'output JSON')
+  .addHelpText(
+    'after',
+    `
+Examples:
+  cat trace/0001_page.html | codeceptq './/input'
+  cat trace/0001_page.html | codeceptq 'Username' --field
+  cat trace/0001_page.html | codeceptq 'Username' '.form' --field
+  codeceptq './/button' --file trace/0001_page.html
+  codeceptq 'Login' --click --file page.html
+
+Exit codes:
+  0  matches found
+  1  no matches
+  2  invalid input or XPath
+`,
+  )
+  .action(async (locator, context, options) => {
+    try {
+      await query(locator, context, options)
+    } catch (err) {
+      console.error(`codeceptq: ${err.message}`)
+      process.exitCode = 2
+    }
+  })
+
+program.parseAsync(process.argv)