@testomatio/reporter 2.8.1 → 2.8.3

package/lib/bin/cli.js

@@ -19,14 +19,14 @@ const filesize_1 = require("filesize");
 const dotenv_1 = __importDefault(require("dotenv"));
 const replay_js_1 = __importDefault(require("../replay.js"));
 const log_js_1 = require("../utils/log.js");
+const pipe_utils_js_1 = require("../utils/pipe_utils.js");
 const debug = (0, debug_1.default)('@testomatio/reporter:cli');
 const version = (0, utils_js_1.getPackageVersion)();
-console.log(picocolors_1.default.cyan(picocolors_1.default.bold(` 🤩 Testomat.io Reporter v${version}`)));
 const program = new commander_1.Command();
 program
     .version(version)
     .option('--env-file <envfile>', 'Load environment variables from env file')
-    .hook('preAction', thisCommand => {
+    .hook('preAction', (thisCommand, actionCommand) => {
     const opts = thisCommand.opts();
     if (opts.envFile) {
         dotenv_1.default.config({ path: opts.envFile });
@@ -34,6 +34,15 @@ program
     else {
         dotenv_1.default.config();
     }
+    // --filter-list produces a machine-readable test list on stdout, so route
+    // logs to stderr and skip the banner to keep stdout clean for piping.
+    const subOpts = actionCommand.opts();
+    if (subOpts.filterList || subOpts.format) {
+        process.env.TESTOMATIO_LOG_STDERR = '1';
+    }
+    else {
+        console.log(picocolors_1.default.cyan(picocolors_1.default.bold(` 🤩 Testomat.io Reporter v${version}`)));
+    }
 });
 program
     .command('start')
@@ -77,6 +86,7 @@ program
     .argument('[command]', 'Test runner command')
     .option('--filter <filter>', 'Additional execution filter')
     .option('--filter-list <filter>', 'Get a list of all tests by filter before running')
+    .option('--format <format>', 'Machine-readable output format for --filter-list (grep, json, newline, ids)')
     .option('--kind <type>', 'Specify run type: automated, manual, or mixed')
     .action(async (command, opts) => {
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
@@ -86,7 +96,7 @@ program
         log_js_1.log.info('Filtering tests...');
         // Example of use: npx @testomatio/reporter run "npx jest" --filter "testomatio:tag-name=frontend"
         // Example of use: npx @testomatio/reporter run "npx jest" --filter "coverage:file=coverage.yml"
-        // Example of use: npx @testomatio/reporter run "npx jest" --filter-list "coverage:file=coverage.yml"
+        // Example of use: npx @testomatio/reporter run --filter-list "coverage:file=coverage.yml" --format grep
         const [pipe, ...optsArray] = opts?.filter ? opts?.filter.split(':') : opts?.filterList.split(':');
         const pipeOptions = optsArray.join(':');
         const prepareRunParams = { pipe, pipeOptions };
@@ -99,19 +109,19 @@ program
                 log_js_1.log.info(picocolors_1.default.yellow('No tests found.'));
                 return;
             }
-            const pattern = `(${tests.join('|')})`;
-            const filteredCommand = (0, utils_js_1.applyFilter)(command, tests);
-            debug(`Execution pattern: "${pattern}"`);
             if (opts.filterList) {
-                if (command)
-                    log_js_1.log.info(picocolors_1.default.green(`Full Running Command: ${filteredCommand}`));
-                log_js_1.log.info();
-                log_js_1.log.info(`Grep string:`);
-                log_js_1.log.info(`${tests.join(', ')}`);
+                const out = (0, pipe_utils_js_1.formatFilterListIds)(tests, opts.format || 'ids');
+                if (out)
+                    console.log(out);
+                // Show the runnable-command hint only in interactive mode (no explicit --format).
+                // When --format is set the user is scripting and doesn't need stderr noise.
+                if (command && !opts.format) {
+                    log_js_1.log.info(picocolors_1.default.green(`Full Running Command: ${(0, utils_js_1.applyFilter)(command, tests)}`));
+                }
                 return;
             }
             if (command && command.split) {
-                command = filteredCommand;
+                command = (0, utils_js_1.applyFilter)(command, tests);
             }
         }
         catch (err) {

package/lib/pipe/coverage.js

@@ -54,7 +54,7 @@ class CoveragePipe {
         this.branch = options?.diff || process.env.COVERAGE_BRANCH || this.#GIT.default_branch;
         this.isBranchDefault = !options.diff && !process.env.COVERAGE_BRANCH;
         if (this.isBranchDefault) {
-            console.log(constants_js_1.APP_PREFIX, `🟡 No "diff" branch provided. That's why we use default one = "${this.branch}".\n` +
+            log_js_1.log.info(`🟡 No "diff" branch provided. That's why we use default one = "${this.branch}".\n` +
                 '👉 You can set it via --filter "coverage:file=coverage.yml,diff=your-branch"');
         }
         // Client config section
@@ -136,7 +136,7 @@ class CoveragePipe {
                 const tests = await this.#getTestomatioTestsByParam(tagType, tag);
                 if (!tests)
                     return [];
-                console.log(constants_js_1.APP_PREFIX, `✅ We found ${tests.length === 1 ? 'one entry' : `${tests.length} (test/suite) entries`}` +
+                log_js_1.log.info(`✅ We found ${tests.length === 1 ? 'one entry' : `${tests.length} (test/suite) entries`}` +
                     ' in Testomat.io service side.');
                 tests.forEach(testId => this.tests.add(testId));
             }
@@ -276,7 +276,7 @@ class CoveragePipe {
             log_js_1.log.error(err.message);
             return undefined;
         }
-        log_js_1.log.error(`ℹ️  We will use '${cmd}' Git command.`);
+        log_js_1.log.warn(`We will use '${cmd}' Git command.`);
         try {
             // For clear unit testing process -> Like test_defaultGitChangedFile = todomvc-tests/edit-todos_test.js
             if (this.isDefaultGitChanges) {
@@ -285,7 +285,7 @@ class CoveragePipe {
             else {
                 this.changedFiles = this.#getChangedFilesFromGit(cmd);
                 if (this.changedFiles.length === 0) {
-                    console.log(constants_js_1.APP_PREFIX, 'ℹ️  No files changed in the latest Git commit. Skipping coverage processing.');
+                    log_js_1.log.info('ℹ️  No files changed in the latest Git commit. Skipping coverage processing.');
                     return undefined;
                 }
             }

package/lib/utils/log.js

@@ -46,7 +46,8 @@ function shouldLog(messageLevel) {
  */
 function info(...args) {
     if (shouldLog(exports.LOG_LEVELS.INFO)) {
-        console.log(constants_js_1.APP_PREFIX, ...args);
+        const fn = process.env.TESTOMATIO_LOG_STDERR === '1' ? console.error : console.log;
+        fn(constants_js_1.APP_PREFIX, ...args);
     }
 }
 /**

package/lib/utils/pipe_utils.d.ts

@@ -54,3 +54,13 @@ export function fullName(t: object): string;
  * => Returns: { foo: 'bar', baz: 'qux' }
  */
 export function parsePipeOptions(optionsStr?: string): any;
+/**
+ * Format a list of test IDs for `--filter-list` machine-readable output.
+ * Used when the CLI `--format` option is passed,
+ * e.g. `--filter-list "coverage:file=..." --format grep`.
+ *
+ * @param {string[]} ids
+ * @param {'grep'|'json'|'newline'|'ids'} format
+ * @returns {string} Empty string if no ids; otherwise the formatted output.
+ */
+export function formatFilterListIds(ids: string[], format: "grep" | "json" | "newline" | "ids"): string;

package/lib/utils/pipe_utils.js

@@ -7,6 +7,7 @@ exports.setS3Credentials = setS3Credentials;
 exports.statusEmoji = statusEmoji;
 exports.fullName = fullName;
 exports.parsePipeOptions = parsePipeOptions;
+exports.formatFilterListIds = formatFilterListIds;
 const log_js_1 = require("./log.js");
 /**
  * Set S3 credentials from the provided artifacts object.
@@ -161,6 +162,26 @@ function parsePipeOptions(optionsStr) {
     }
     return options;
 }
+/**
+ * Format a list of test IDs for `--filter-list` machine-readable output.
+ * Used when the CLI `--format` option is passed,
+ * e.g. `--filter-list "coverage:file=..." --format grep`.
+ *
+ * @param {string[]} ids
+ * @param {'grep'|'json'|'newline'|'ids'} format
+ * @returns {string} Empty string if no ids; otherwise the formatted output.
+ */
+function formatFilterListIds(ids, format) {
+    if (!ids || ids.length === 0)
+        return '';
+    switch (format) {
+        case 'grep': return `(${ids.join('|')})`;
+        case 'json': return JSON.stringify(ids);
+        case 'newline': return ids.join('\n');
+        case 'ids':
+        default: return ids.join(',');
+    }
+}
 
 module.exports.updateFilterType = updateFilterType;
 
@@ -175,3 +196,5 @@ module.exports.statusEmoji = statusEmoji;
 module.exports.fullName = fullName;
 
 module.exports.parsePipeOptions = parsePipeOptions;
+
+module.exports.formatFilterListIds = formatFilterListIds;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.8.1",
+  "version": "2.8.3",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"

package/src/bin/cli.js

@@ -15,22 +15,31 @@ import { filesize as prettyBytes } from 'filesize';
 import dotenv from 'dotenv';
 import Replay from '../replay.js';
 import { log } from '../utils/log.js';
+import { formatFilterListIds } from '../utils/pipe_utils.js';
 
 const debug = createDebugMessages('@testomatio/reporter:cli');
 const version = getPackageVersion();
-console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
 const program = new Command();
 
 program
   .version(version)
   .option('--env-file <envfile>', 'Load environment variables from env file')
-  .hook('preAction', thisCommand => {
+  .hook('preAction', (thisCommand, actionCommand) => {
     const opts = thisCommand.opts();
     if (opts.envFile) {
       dotenv.config({ path: opts.envFile });
     } else {
       dotenv.config();
     }
+
+    // --filter-list produces a machine-readable test list on stdout, so route
+    // logs to stderr and skip the banner to keep stdout clean for piping.
+    const subOpts = actionCommand.opts();
+    if (subOpts.filterList || subOpts.format) {
+      process.env.TESTOMATIO_LOG_STDERR = '1';
+    } else {
+      console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
+    }
   });
 
 program
@@ -83,6 +92,7 @@ program
   .argument('[command]', 'Test runner command')
   .option('--filter <filter>', 'Additional execution filter')
   .option('--filter-list <filter>', 'Get a list of all tests by filter before running')
+  .option('--format <format>', 'Machine-readable output format for --filter-list (grep, json, newline, ids)')
   .option('--kind <type>', 'Specify run type: automated, manual, or mixed')
   .action(async (command, opts) => {
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
@@ -93,7 +103,7 @@ program
       log.info('Filtering tests...');
       // Example of use: npx @testomatio/reporter run "npx jest" --filter "testomatio:tag-name=frontend"
       // Example of use: npx @testomatio/reporter run "npx jest" --filter "coverage:file=coverage.yml"
-      // Example of use: npx @testomatio/reporter run "npx jest" --filter-list "coverage:file=coverage.yml"
+      // Example of use: npx @testomatio/reporter run --filter-list "coverage:file=coverage.yml" --format grep
       const [pipe, ...optsArray] = opts?.filter ? opts?.filter.split(':') : opts?.filterList.split(':');
       const pipeOptions = optsArray.join(':');
 
@@ -110,21 +120,19 @@ program
           return;
         }
 
-        const pattern = `(${tests.join('|')})`;
-        const filteredCommand = applyFilter(command, tests);
-
-        debug(`Execution pattern: "${pattern}"`);
-
-        if(opts.filterList) {
-          if (command) log.info(pc.green(`Full Running Command: ${filteredCommand}`));
-          log.info();
-          log.info(`Grep string:`);
-          log.info(`${tests.join(', ')}`);
+        if (opts.filterList) {
+          const out = formatFilterListIds(tests, opts.format || 'ids');
+          if (out) console.log(out);
+          // Show the runnable-command hint only in interactive mode (no explicit --format).
+          // When --format is set the user is scripting and doesn't need stderr noise.
+          if (command && !opts.format) {
+            log.info(pc.green(`Full Running Command: ${applyFilter(command, tests)}`));
+          }
           return;
         }
 
         if (command && command.split) {
-          command = filteredCommand;
+          command = applyFilter(command, tests);
         }
       }
       catch (err) {

package/src/pipe/coverage.js

@@ -57,8 +57,7 @@ class CoveragePipe { // or Changes for the future???
         this.isBranchDefault = !options.diff && !process.env.COVERAGE_BRANCH;
 
         if (this.isBranchDefault) {
-            console.log(
-                APP_PREFIX,
+            log.info(
                 `🟡 No "diff" branch provided. That's why we use default one = "${this.branch}".\n` +
                 '👉 You can set it via --filter "coverage:file=coverage.yml,diff=your-branch"'
             );
@@ -154,8 +153,7 @@ class CoveragePipe { // or Changes for the future???
 
                 if (!tests) return [];
 
-                console.log(
-                    APP_PREFIX,
+                log.info(
                     `✅ We found ${tests.length === 1 ? 'one entry' : `${tests.length} (test/suite) entries`}` +
                     ' in Testomat.io service side.'
                 );
@@ -324,7 +322,7 @@ class CoveragePipe { // or Changes for the future???
             return undefined;
         }
 
-        log.error( `ℹ️  We will use '${cmd}' Git command.`);
+        log.warn( `We will use '${cmd}' Git command.`);
 
         try {
             // For clear unit testing process -> Like test_defaultGitChangedFile = todomvc-tests/edit-todos_test.js
@@ -335,10 +333,7 @@ class CoveragePipe { // or Changes for the future???
                 this.changedFiles =  this.#getChangedFilesFromGit(cmd);
 
                 if (this.changedFiles.length === 0) {
-                    console.log(
-                        APP_PREFIX,
-                        'ℹ️  No files changed in the latest Git commit. Skipping coverage processing.'
-                    );
+                    log.info('ℹ️  No files changed in the latest Git commit. Skipping coverage processing.');
 
                     return undefined;
                 }

package/src/utils/log.js

@@ -42,7 +42,8 @@ export function shouldLog(messageLevel) {
  */
 export function info(...args) {
   if (shouldLog(LOG_LEVELS.INFO)) {
-    console.log(APP_PREFIX, ...args);
+    const fn = process.env.TESTOMATIO_LOG_STDERR === '1' ? console.error : console.log;
+    fn(APP_PREFIX, ...args);
   }
 }
 

package/src/utils/pipe_utils.js

@@ -161,12 +161,33 @@ function parsePipeOptions(optionsStr) {
   return options;
 }
 
-export { 
-  updateFilterType, 
-  parseFilterParams, 
-  generateFilterRequestParams, 
-  setS3Credentials, 
-  statusEmoji, 
+/**
+ * Format a list of test IDs for `--filter-list` machine-readable output.
+ * Used when the CLI `--format` option is passed,
+ * e.g. `--filter-list "coverage:file=..." --format grep`.
+ *
+ * @param {string[]} ids
+ * @param {'grep'|'json'|'newline'|'ids'} format
+ * @returns {string} Empty string if no ids; otherwise the formatted output.
+ */
+function formatFilterListIds(ids, format) {
+  if (!ids || ids.length === 0) return '';
+  switch (format) {
+    case 'grep': return `(${ids.join('|')})`;
+    case 'json': return JSON.stringify(ids);
+    case 'newline': return ids.join('\n');
+    case 'ids':
+    default: return ids.join(',');
+  }
+}
+
+export {
+  updateFilterType,
+  parseFilterParams,
+  generateFilterRequestParams,
+  setS3Credentials,
+  statusEmoji,
   fullName,
-  parsePipeOptions
+  parsePipeOptions,
+  formatFilterListIds,
 };