I guess our expected behaviour would be either to update the documentation or to mark them as optional in the type.
I hope suggestions are welcome: I assume you've not made them optional because internally, your reporter always has the summary and steps defined. What I've usually done in the past when developing plugins is to split the configuration types into an internal (not exported) and an external (exported to users) version so that internally I can use the required summary without adding if (config.summary) unnecessarily.
Desktop (please complete the following information):
Hi,
in #86 you exposed the
XrayOptions
to users of the reporter (thanks for that!). But I think there's a small issue with the optional properties.According to the documentation,
stepCategories
andsummary
are optional settings. But inXrayOptions
, they are required.MRE
Expected behaviour
I guess our expected behaviour would be either to update the documentation or to mark them as optional in the type.
I hope suggestions are welcome: I assume you've not made them optional because internally, your reporter always has the summary and steps defined. What I've usually done in the past when developing plugins is to split the configuration types into an internal (not exported) and an external (exported to users) version so that internally I can use the required summary without adding
if (config.summary)
unnecessarily.Desktop (please complete the following information):