GRECLIPSE

Groovy formatter does not use correct Java formatter settings

Details

  • Type: Bug Bug
  • Status: Resolved Resolved
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 2.5.1Release
  • Fix Version/s: 2.5.2.Release
  • Component/s: Editor, Formatting
  • Labels:
    None
  • Environment:
    Linux, SpringSource Tool Suite 2.7.1.RELEASE
  • Number of attachments :
    0

Description

The formatter for Groovy source code does not use the correct Java formatter settings for indentation. In the STS (Eclipse) "Java -> Code Style -> Formatter" preferences, I edit the format and in the "Profile" dialog. On the "Indentation" tab, I set "Tab policy" to "Spaces only", "Indentation size" to "2", and "Tab size" to "8". Now, when I select some Groovy code and press "Ctrl+Shift+F", the Groovy editor uses the "Tab size" value of 8 spaces to indent my code, not the indentation size of "2" spaces. The editor/formatter should use the indentation size, not the tab size for indentation. The tab size is just the number of spaces to use to represent a tab character (I set mine to match my printer's and terminal's default tab size); it should have no effect on the code formatting.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Andrew Eisenberg added a comment -

A more complete specification of the behavior is this:

  • When set to "spaces only", tab size is used only for the tab key. Indentation size is how many spaces each line is indented by (this is what you describe above).
  • When set to "tabs only", indentation size is greyed out and its value is copied to tab size.
  • When set to "mixed", it looks like a reformat will use spaces and the indentation size.
Show
Andrew Eisenberg added a comment - A more complete specification of the behavior is this: When set to "spaces only", tab size is used only for the tab key. Indentation size is how many spaces each line is indented by (this is what you describe above). When set to "tabs only", indentation size is greyed out and its value is copied to tab size. When set to "mixed", it looks like a reformat will use spaces and the indentation size.
Hide
Permalink
Andrew Eisenberg added a comment -

It looks like the problem only occurs in "spaces" mode. The JDT preferences are confusing. It looks like when in "spaces" mode, we need to set the indentation size to be the tab size. If I do this, then everything is working for me. I will write up a few regression tests.

Unfortunately, the greclipse svn repo is closed for commits right now. When it is available again, I will commit the changes.

Show
Andrew Eisenberg added a comment - It looks like the problem only occurs in "spaces" mode. The JDT preferences are confusing. It looks like when in "spaces" mode, we need to set the indentation size to be the tab size. If I do this, then everything is working for me. I will write up a few regression tests. Unfortunately, the greclipse svn repo is closed for commits right now. When it is available again, I will commit the changes.
Hide
Permalink
Andrew Eisenberg added a comment -

OK. Wrote up a few tests. Ultimately, I am confused by this since it seems like JDT is using the wrong value for spaces mode. Somehow JDT sets the tab size to be the indent size and then uses the tab size to calculate the number of spaces to use.

This is not a bug in JDT, but it may be some sort of legacy from a long time ago when the editor did not really distinguish between tab size and indent size.

Fixed now. Groovy code now exhibits the same behavior as Java code. Waiting to commit.

Show
Andrew Eisenberg added a comment - OK. Wrote up a few tests. Ultimately, I am confused by this since it seems like JDT is using the wrong value for spaces mode. Somehow JDT sets the tab size to be the indent size and then uses the tab size to calculate the number of spaces to use. This is not a bug in JDT, but it may be some sort of legacy from a long time ago when the editor did not really distinguish between tab size and indent size. Fixed now. Groovy code now exhibits the same behavior as Java code. Waiting to commit.
Hide
Permalink
Andrew Eisenberg added a comment -

Will be available in next dev build (whenever that is).

Show
Andrew Eisenberg added a comment - Will be available in next dev build (whenever that is).

People

  • Assignee:
    Andrew Eisenberg
    Reporter:
    D Gardner
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: