Integrate feature comments in the cucumber reporting

[ouquoi]

Is there a way to add the comment in feature file to the html report ?
Thanks for your help.

[damianszczepanik]

Do you have sample JSON report with comments? Attach for reference

[damianszczepanik]

Closing as no feedback so far.

[jfougere]

Hi @damianszczepanik just found this issue. I am actually looking for this feature also.

Below is an example of the json genrated by karate and which are the inputs for the cucumber reporting:

"step": {
            "comments": [
              "# Step 1: Subscribe to product"
            ],
           ....
          },

Such comment are present in the Karate reporting but I'd like to have such comments in the cucumber report.

Do you think this could be done ? It would be nice to have a display similar to feature descriptions.

[damianszczepanik]

Would be nice. You can prepare PR if you like so I can help

[jfougere]

Hi @damianszczepanik my bad in fact Karate make those comments available only for the json produce for its own report but not for the json used as input for cucumber reporting.

Locally I prepared two changes one on Karate to add the comments and one on cucumber-reporting to use them and it works good.

The result looks like this:

So I will try on Karate side to see if they are open for a PR to add comments on the produced json.

[fslev]

Sorry but I do not agree with this feature.
What will happen if Cucumber will add their own feature for generating comments inside the JSON report ? This is a Cucumber Report library and not a Karate report library.

[damianszczepanik]

Then we will decide what to do