Report customization options

[gasparnagy]

🤔 What's the problem you're trying to solve?

While integrating the HTML formatter to Reqnroll, I have encountered two things that would be good to make easily customizable without using a complete custom template.

1. Page title. Currently it is fixed to "Cucumber" by the index.mustache.html. It would be good to set this to something related to the test execution that generated it. E.g. .NET TRX reports named like gaspar@MACHINE 2025-08-06 14:40:20.
2. Page icon. This is pretty low prio, but when integrated to Reqnroll, it would be nice to be able to set the icon to the Reqnroll icon.

✨ What's your proposed solution?

I don't have a final idea about this, but an obvious solution would be to make these also as parameters in index.mustache.html ({{title}} and {{icon}}) and allow specifying values for these in the HtmlFormatter classes optionally. They would fall back to Cucumber and cucumber icon if the values are not customized.

What do you think?

⛏ Have you considered any alternatives or workarounds?

No response

📚 Any additional context?

No response

[mpkorstanje]

Sounds like the right solution. I'd also add custom style sheets and javascript to the list of customization options.

Now I imagine there will be quite a few parameters, most of which would have default values for most cases, so for Java I'd use a builder pattern.

Not sure what the .Net equivalent is for that.

[gasparnagy]

I'd also add custom style sheets and javascript to the list of customization options.

You mean adding something like {{custom-css}} and {{custom-js}} after the normal css and js and keep it empty by default?

Now I imagine there will be quite a few parameters, most of which would have default values for most cases, so for Java I'd use a builder pattern.
Not sure what the .Net equivalent is for that.

Maybe, but I can't see yet what you mean exactly with the builders. A builder class that can return the needed assets, but has methods like WithCustomTitle(...) to alter the defaults? And this builder class would be injected to the html writer classes?

[mpkorstanje]

You mean adding something like {{custom-css}} and {{custom-js}} after the normal css and js and keep it empty by default?

Yes, something like that.

A builder class that can return the needed assets, but has methods like WithCustomTitle(...) to alter the defaults?

Essentially yes. Though I don't know which patterns are popular in .Net for that.

And this builder class would be injected to the html writer classes?

For Java it would be the builder of the writer, though I suppose it could also be the builder of a configuration object passed to the constructor of the writer.

If it helps I can probably sketch out an outline in Java next week, but if you got the idea don't wait for that.

[gasparnagy]

For Java it would be the builder of the writer, though I suppose it could also be the builder of a configuration object passed to the constructor of the writer.

I would prefer to make it a builder of the configuration, because that would support my customization goals with #400

If it helps I can probably sketch out an outline in Java next week, but if you got the idea don't wait for that.

OK. Let's see.

[mpkorstanje]

I would prefer to make it a builder of the configuration, because that would support my customization goals with #400

That sounds good to me. The exact API design can be pretty language specific anyway. Depends a lot on language features.

[vitalets]

I'd also add custom style sheets and javascript to the list of customization options.

I'd vote for this too. Being able to inject js actually allows any customization of the report.
Currently, I hijack formatter stream to inject js and css, that's quite messy.