added warning for old collection comments

CHANGELOG.md

@@ -1,3 +1,6 @@
+* 2.3.2
+  - added warning for old collection comments
+
 * 2.3.1
   - updated coverage reports
 

lib/utils/util.js

@@ -13,10 +13,12 @@ const defaultOptions = require('../default/options.js');
 const assetsName = 'assets';
 
 const Util = {
+    ... Share,
 
-    root: process.cwd(),
+    EC,
+    CG,
 
-    ... Share,
+    root: process.cwd(),
 
     relativePath: function(p, root) {
         p = `${p}`;

lib/visitor.js

@@ -7,6 +7,19 @@ const {
 const Util = require('./utils/util.js');
 const commentsPlugin = require('./plugins/comments.js');
 const defaultColumns = require('./default/columns.js');
+
+// retired, just warning for old babel parser
+let collectWarning = '"collect.comments()" has been deprecated (replaced with new option "customFieldsInComments: true/false" in version 2.2.0), please remove the code related to "collect.comments()" in custom "visitor".';
+const collect = new Proxy({}, {
+    get: function(obj, prop) {
+        if (collectWarning) {
+            Util.logError(collectWarning);
+            collectWarning = null;
+        }
+        return () => {};
+    }
+});
+
 class Visitor {
     constructor(root, options) {
         this.root = root;
@@ -111,13 +124,13 @@ class Visitor {
 
         // for all data
         if (this.customCommonVisitor) {
-            await this.customCommonVisitor.call(this, data, metadata);
+            await this.customCommonVisitor.call(this, data, metadata, collect);
         }
 
         // for single column data (high priority)
         if (this.customVisitors) {
             for (const item of this.customVisitors) {
-                const res = await item.visitor.call(this, data, metadata);
+                const res = await item.visitor.call(this, data, metadata, collect);
                 if (typeof res !== 'undefined') {
                     data[item.id] = res;
                 }

tests/playwright.config.js

@@ -294,7 +294,7 @@ module.exports = {
             },
 
             // additional custom visitor for columns
-            visitor: (data, metadata) => {
+            visitor: (data, metadata, collect) => {
 
                 // remove secrets and sensitive data
                 if (data.type === 'step') {
@@ -314,6 +314,12 @@ module.exports = {
 
                 }
 
+                // test issue #91
+                const comments = collect.comments();
+                if (comments) {
+                    Object.assign(data, comments);
+                }
+
 
             },