= in comments disappears and increases font size

SonarQube Server / Community Build
1

  • versions used
    Version 7.1 (build 11001)LGPL v3

  • error observed
    When adding comments to a issue, putting = sign causes odd behavior.

  • steps to reproduce
    Go to issues
    Add a comment with = symbol such as:

“Something like…
public ByteField LivedInComState { get; set; } = new ByteField();”

Where I was adding a suggestion.
Save it and observe the displayed result.

  • potential workaround
    None that I know of.
2

I agree that = embedded in text should not have such weird results.
Here’s the ticket to track the progress of the fix:
https://jira.sonarsource.com/browse/SONAR-11081

In this particular example, it would be best to apply code style to the sample code part of the comment, using double back-ticks, as hinted by the comment form:
image

This way the comment will be rendered as:

image
image.png792×44 6.8 KB

1 Like
3

I can report that this bug still exists as of 8.6 (I was about to file a bug report but did a search and found this one). When I used the web_api to add a comment and then fetch it, I noticed that the equals sign had been turned into < h 1 > (but with no spaces, i.e., an HTML header tag) which probably explains the appearance (everything after the missing equals sign being rendered in a larger font, since the web browser interprets it as HTML). (The comment that comes out of the web_api call also has the closing tag added. I guess they figured if they’re going to mangle comments, at least mangle them consistently… :slight_smile: )

(To add a clarification: I got the equals-to-H1-tag conversion using the web_api rather than the web portal, so the conversion seen by the OP is not being done by the web browser itself, but something common to both the web portal and web_api.)

4

So is there a workaround for this? I tried changing the = to an HTML entity, but neither Xequals; nor X#61; (replace X with ampersand in both) work. It appears that in THIS case, it decided to turn the ampersand into the HTML code for ampersand.

So it seems I can’t win – it mangles non-HTML into HTML and vice versa.

5

Another thing I noticed is that the = is mangled only in the htmlText field of the comment object; the markdown field seems to be unaffected.