codeceptjs 4.0.0-rc.8 → 4.0.0

package/README.md

@@ -251,20 +251,22 @@ Add the `testomatio` plugin to your `codecept.conf.js`:
 plugins: {
   testomatio: {
     enabled: true,
-    require: '@testomatio/reporter/lib/adapter/codecept',
+    require: '@testomatio/reporter/codecept',
+    html: true,
+    reportDir: 'output/report',
   },
 }
 ```
 
 ### Usage
 
-Generate HTML reports by setting the `TESTOMATIO_HTML_REPORT_SAVE` environment variable:
+Run tests normally:
 
 ```sh
-TESTOMATIO_HTML_REPORT_SAVE=1 npx codeceptjs run
+npx codeceptjs run
 ```
 
-The report will be saved to `html-report/testomatio-report.html`.
+The report will be saved to `output/report/testomatio-report.html` by default. You can also keep using `TESTOMATIO_HTML_REPORT_SAVE=1` and related environment variables if you prefer env-based setup.
 
 ### Features
 
@@ -278,14 +280,11 @@ The report will be saved to `html-report/testomatio-report.html`.
 ### Customization
 
 ```sh
-# Custom output folder
-TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO_HTML_REPORT_FOLDER=./reports npx codeceptjs run
-
-# Custom filename
-TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO_HTML_FILENAME=my-report.html npx codeceptjs run
+# Custom output folder in codecept.conf.js
+# reportDir: './reports'
 
 # Integrate with Testomat.io cloud
-TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO=your_api_key npx codeceptjs run
+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)