Unsupported tags dl and dt

[vnaskos-sonar]

After the #5406 on SLVS it was identified that there is an issue with the following rule due to unsupported tags dl and dt

S6966

<p>Using a synchronous method instead of its <a href="https://learn.microsoft.com/en-us/dotnet/csharp/asynchronous-programming/">asynchronous</a>
counterpart in an <code>async</code> method blocks the execution and is considered bad practice for several reasons:</p>
<dl>
  <dt>

[martin-strecker-sonarsource]

Rendering is supported by other consumer such as SonarQube:
https://peach.aws-prd.sonarsource.com/coding_rules?q=S6966&open=csharpsquid%3AS6966

[georgii-borovinskikh-sonarsource]

Hey @martin-strecker-sonarsource
The issue is that we can't directly display HTML in the IDE. We convert it to XAML, and we need to update the conversion code for each new html tag that is used. It's technically not an issue on your side, it's just a bit of a painful process for us to update the converter for tags that are used only in one rule. If you think that this tag is really needed, then we will have to fix it on our side at some point. But in general, it is easier to fix it on your side than on ours.

[martin-strecker-sonarsource]

We can change the rule rspec but we also do have a second rule in the pipeline with definition lists:

https://github.com/SonarSource/rspec/pull/3668/files#diff-0429ce0e4c469b55eba4b8851ed523317e5c786281f08520a665b956f4c2541a

If we change the rules, the rpsec CI needs to be adopted to flag definition lists as unsupported. Doing so might be as much of an effort as to support it on your side. What do you think?

[georgii-borovinskikh-sonarsource]

@martin-strecker-sonarsource if it's multiple rules that reuse this feature, then it definitely makes more sense to add the support on our side

[pavel-mikula-sonarsource]

There exists a showcase plugin that contains show-case RSPEC that demonstrates all legal formating that rules can use, and that products must support.

Actual rules can be found here.

I have not seen <dl> and <dt> being used there, therefore rules should not expect products to be able to display those.

We need to fix the RSPEC to conform to the existing set of supported HTML nodes.

If there's a real need, we can talk with CFamily Squad about what it takes to add new nodes, reach an agreement with products and update the showcase. Only after that we can start using new nodes.

[pavel-mikula-sonarsource]

Just FYI - it doesn't change anything about this ticket: I've created #5422 to create UT based on the showcase plugin, so we learn about new formatting elements before the problem happens.