Potential minor bug with Tidy and inline comments

[donnyh13]

Hi @Jos,

I just noticed a (potential) minor bug with Tidy and inline comments. If you run Tidy, and it has to de-indent a line of script with an inline comment at the end, it leaves the comments in its original position, adding spaces after the script line. Is this a purposeful thing?

Try running Tidy on this, with no parameters set for Tidy:

Quote

            Local $aVar ; Test

And it will result in this:

Quote

Local $aVar             ; Test

Best regards,

Donny

Edited March 23 by donnyh13

[Jos]

I guess the first code should have been indented, but the tabs were removed?
It is indeed the case that as default the code is properly indented and the inline comments start position is kept where possible.

This is considered a feature that the inline comments stay aligned when the code indentation is changed.

e.g.

Local $aVar                     ; Test
            Local $aVar         ; Test
    Local $aVar                 ; Test
Local $aVar                     ; Test

will result in

Local $aVar                     ; Test
Local $aVar                     ; Test
Local $aVar                     ; Test
Local $aVar                     ; Test

 

Edited March 23 by Jos

[donnyh13]

1 hour ago, Jos said:

but the tabs were removed

Yes, sorry, I didn't notice that,

It was a simple example, but where I ran into it was running tidy on code that had been tidied, but then having removed some "If" blocks, thus making the indent level decrease. After running Tidy, I seen that my comments that were only 1 space away from the end of the line before, became 4 or more spaces away. But if this is intended, then it's not a big deal, as I can see its use, per your example.

Original Tidied code:

If 1 = 1 Then ; A comment 1 space away.
    If 2 = 2 Then ; A comment 1 space away.
        If 3 = 3 Then ; A comment 1 space away.
        EndIf
    EndIf
EndIf

Remove one level of "IF"'s and tidy again:

;~ If 1 = 1 Then ; A comment 1 space away.
If 2 = 2 Then     ; A comment 1 space away.
    If 3 = 3 Then     ; A comment 1 space away.
    EndIf
EndIf
;~ EndIf

 

Edited March 23 by donnyh13

[Jos]

There is also a -1 option for the Support for directive #Tidy_ILC_Pos=nn  as you can see here.
This is the previous Tidy behaviour, where all spaces were trimmed to one space between end of code and comment.
I will update the documentation to include that info.

 

[Jos]

Just uploaded an updated Tidy to the Beta directory that now also has option #Tidy_ILC_Pos=-2
The -2 option will simply copy any existing Whitespace characters between the Code and InlineComment, from the existing line to the newly indented line.

Try that and see if that is what you are looking for, but I thought it would be nice to make that available as well as option.  🙂 

 

[donnyh13]

Thanks Jos! That works great.